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 /* obtain the time of an event */
81 static inline LttTime
getEventTime(LttTracefile
* tf
);
84 /* set the offset of the fields belonging to the event,
85 need the information of the archecture */
86 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
);
87 //size_t get_fields_offsets(LttTracefile *tf, LttEventType *event_type, void *data);
89 /* get the size of the field type according to
90 * The facility size information. */
91 static inline void preset_field_type_size(LttTracefile
*tf
,
92 LttEventType
*event_type
,
93 off_t offset_root
, off_t offset_parent
,
94 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
97 /* map a fixed size or a block information from the file (fd) */
98 static gint
map_block(LttTracefile
* tf
, guint block_num
);
100 /* calculate nsec per cycles for current block */
101 static double calc_nsecs_per_cycle(LttTracefile
* t
);
103 /* go to the next event */
104 static int ltt_seek_next_event(LttTracefile
*tf
);
106 void ltt_update_event_size(LttTracefile
*tf
);
109 /* Functions to parse system.xml file (using glib xml parser) */
110 static void parser_start_element (GMarkupParseContext __UNUSED__
*context
,
111 const gchar
*element_name
,
112 const gchar
**attribute_names
,
113 const gchar
**attribute_values
,
118 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
119 if(strcmp("system", element_name
)){
120 *error
= g_error_new(G_MARKUP_ERROR
,
122 "This is not system.xml file");
126 while(attribute_names
[i
]){
127 if(strcmp("node_name", attribute_names
[i
])==0){
128 des
->node_name
= g_strdup(attribute_values
[i
]);
129 }else if(strcmp("domainname", attribute_names
[i
])==0){
130 des
->domain_name
= g_strdup(attribute_values
[i
]);
131 }else if(strcmp("cpu", attribute_names
[i
])==0){
132 des
->nb_cpu
= atoi(attribute_values
[i
]);
133 }else if(strcmp("arch_size", attribute_names
[i
])==0){
134 if(strcmp(attribute_values
[i
],"LP32") == 0) des
->size
= LTT_LP32
;
135 else if(strcmp(attribute_values
[i
],"ILP32") == 0) des
->size
= LTT_ILP32
;
136 else if(strcmp(attribute_values
[i
],"LP64") == 0) des
->size
= LTT_LP64
;
137 else if(strcmp(attribute_values
[i
],"ILP64") == 0) des
->size
= LTT_ILP64
;
138 else if(strcmp(attribute_values
[i
],"UNKNOWN") == 0) des
->size
= LTT_UNKNOWN
;
139 }else if(strcmp("endian", attribute_names
[i
])==0){
140 if(strcmp(attribute_values
[i
],"LITTLE_ENDIAN") == 0)
141 des
->endian
= LTT_LITTLE_ENDIAN
;
142 else if(strcmp(attribute_values
[i
],"BIG_ENDIAN") == 0)
143 des
->endian
= LTT_BIG_ENDIAN
;
144 }else if(strcmp("kernel_name", attribute_names
[i
])==0){
145 des
->kernel_name
= g_strdup(attribute_values
[i
]);
146 }else if(strcmp("kernel_release", attribute_names
[i
])==0){
147 des
->kernel_release
= g_strdup(attribute_values
[i
]);
148 }else if(strcmp("kernel_version", attribute_names
[i
])==0){
149 des
->kernel_version
= g_strdup(attribute_values
[i
]);
150 }else if(strcmp("machine", attribute_names
[i
])==0){
151 des
->machine
= g_strdup(attribute_values
[i
]);
152 }else if(strcmp("processor", attribute_names
[i
])==0){
153 des
->processor
= g_strdup(attribute_values
[i
]);
154 }else if(strcmp("hardware_platform", attribute_names
[i
])==0){
155 des
->hardware_platform
= g_strdup(attribute_values
[i
]);
156 }else if(strcmp("operating_system", attribute_names
[i
])==0){
157 des
->operating_system
= g_strdup(attribute_values
[i
]);
158 }else if(strcmp("ltt_major_version", attribute_names
[i
])==0){
159 des
->ltt_major_version
= atoi(attribute_values
[i
]);
160 }else if(strcmp("ltt_minor_version", attribute_names
[i
])==0){
161 des
->ltt_minor_version
= atoi(attribute_values
[i
]);
162 }else if(strcmp("ltt_block_size", attribute_names
[i
])==0){
163 des
->ltt_block_size
= atoi(attribute_values
[i
]);
165 *error
= g_error_new(G_MARKUP_ERROR
,
167 "Not a valid attribute");
174 static void parser_characters (GMarkupParseContext __UNUSED__
*context
,
176 gsize __UNUSED__ text_len
,
178 GError __UNUSED__
**error
)
180 LttSystemDescription
* des
= (LttSystemDescription
* )user_data
;
181 des
->description
= g_strdup(text
);
184 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
,
187 g_assert(num
< t
->facilities_by_num
->len
);
189 return &g_array_index(t
->facilities_by_num
, LttFacility
, num
);
194 /*****************************************************************************
196 * ltt_tracefile_open : open a trace file, construct a LttTracefile
198 * t : the trace containing the tracefile
199 * fileName : path name of the trace file
200 * tf : the tracefile structure
202 * : 0 for success, -1 otherwise.
203 ****************************************************************************/
205 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
)
207 struct stat lTDFStat
; /* Trace data file status */
208 struct ltt_block_start_header
*header
;
209 int page_size
= getpagesize();
212 tf
->name
= g_quark_from_string(fileName
);
214 tf
->fd
= open(fileName
, O_RDONLY
);
216 g_warning("Unable to open input data file %s\n", fileName
);
220 // Get the file's status
221 if(fstat(tf
->fd
, &lTDFStat
) < 0){
222 g_warning("Unable to get the status of the input data file %s\n", fileName
);
226 // Is the file large enough to contain a trace
227 if(lTDFStat
.st_size
< (off_t
)(sizeof(struct ltt_block_start_header
))){
228 g_print("The input data file %s does not contain a trace\n", fileName
);
232 /* Temporarily map the buffer start header to get trace information */
233 /* Multiple of pages aligned head */
234 tf
->buffer
.head
= mmap(0,
235 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)), PROT_READ
,
236 MAP_PRIVATE
, tf
->fd
, 0);
237 if(tf
->buffer
.head
== MAP_FAILED
) {
238 perror("Error in allocating memory for buffer of tracefile");
241 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
243 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
245 if(header
->trace
.magic_number
== LTT_MAGIC_NUMBER
)
247 else if(header
->trace
.magic_number
== LTT_REV_MAGIC_NUMBER
)
249 else /* invalid magic number, bad tracefile ! */
252 //store the size of the file
253 tf
->file_size
= lTDFStat
.st_size
;
254 tf
->block_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
255 tf
->num_blocks
= tf
->file_size
/ tf
->block_size
;
257 munmap(tf
->buffer
.head
, PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
258 tf
->buffer
.head
= NULL
;
260 //read the first block
261 if(map_block(tf
,0)) {
262 perror("Cannot map block for tracefile");
270 munmap(tf
->buffer
.head
, PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
278 /*****************************************************************************
279 *Open control and per cpu tracefiles
280 ****************************************************************************/
282 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
285 tf
= ltt_tracefile_open(t
,tracefile_name
);
287 t
->per_cpu_tracefile_number
++;
288 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
291 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
300 tf
= ltt_tracefile_open(t
,control_name
);
302 g_warning("ltt_tracefile_open_control : bad file descriptor");
305 t
->control_tracefile_number
++;
306 g_ptr_array_add(t
->control_tracefiles
,tf
);
308 //parse facilities tracefile to get base_id
309 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
311 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
313 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
315 fLoad
.name
= (gchar
*)pos
;
316 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
317 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
319 for(i
=0;i
<t
->facility_number
;i
++){
320 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
321 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
322 f
->base_id
= fLoad
.base_code
;
326 if(i
==t
->facility_number
) {
327 g_warning("Facility: %s, checksum: %u is not found",
328 fLoad
.name
,(unsigned int)fLoad
.checksum
);
331 }else if(ev
.event_id
== TRACE_BLOCK_START
){
333 }else if(ev
.event_id
== TRACE_BLOCK_END
){
336 g_warning("Not valid facilities trace file");
345 /*****************************************************************************
347 * ltt_tracefile_close: close a trace file,
349 * t : tracefile which will be closed
350 ****************************************************************************/
352 void ltt_tracefile_close(LttTracefile
*t
)
354 if(t
->buffer
.head
!= NULL
)
355 munmap(t
->buffer
.head
, t
->buf_size
);
360 /*****************************************************************************
361 *Get system information
362 ****************************************************************************/
364 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
371 GMarkupParseContext
* context
;
372 GError
* error
= NULL
;
373 GMarkupParser markup_parser
=
375 parser_start_element
,
378 NULL
, /* passthrough */
382 fd
= g_open(pathname
, O_RDONLY
, 0);
384 g_warning("Can not open file : %s\n", pathname
);
388 iochan
= g_io_channel_unix_new(fd
);
390 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
392 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
393 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
394 != G_IO_STATUS_EOF
) {
397 g_warning("Can not read xml file: \n%s\n", error
->message
);
400 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
402 g_warning("Can not parse xml file: \n%s\n", error
->message
);
405 g_markup_parse_context_free(context
);
407 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
409 g_warning("Can not close file: \n%s\n", error
->message
);
417 g_markup_parse_context_free(context
);
419 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
421 g_warning("Can not close file: \n%s\n", error
->message
);
432 /*****************************************************************************
433 *The following functions get facility/tracefile information
434 ****************************************************************************/
436 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
443 gchar fullname
[DIR_NAME_SIZE
];
444 GError
* error
= NULL
;
446 dir
= g_dir_open(eventdefs
, 0, &error
);
449 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
454 while((name
= g_dir_read_name(dir
)) != NULL
){
455 if(!g_pattern_match_simple("*.xml", name
)) continue;
456 strcpy(fullname
,eventdefs
);
457 strcat(fullname
,name
);
458 ltt_facility_open(t
,fullname
);
462 for(j
=0;j
<t
->facility_number
;j
++){
463 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
464 for(i
=0; i
<f
->event_number
; i
++){
466 setFieldsOffset(NULL
, et
, NULL
, t
);
473 /*****************************************************************************
474 *A trace is specified as a pathname to the directory containing all the
475 *associated data (control tracefiles, per cpu tracefiles, event
478 *When a trace is closed, all the associated facilities, types and fields
479 *are released as well.
483 /****************************************************************************
484 * get_absolute_pathname
486 * return the unique pathname in the system
488 * MD : Fixed this function so it uses realpath, dealing well with
489 * forgotten cases (.. were not used correctly before).
491 ****************************************************************************/
492 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
494 abs_pathname
[0] = '\0';
496 if ( realpath (pathname
, abs_pathname
) != NULL
)
500 /* error, return the original path unmodified */
501 strcpy(abs_pathname
, pathname
);
507 /* Search for something like : .*_.*
509 * The left side is the name, the right side is the number.
512 int get_tracefile_name_number(const gchar
*raw_name
,
516 guint raw_name_len
= strlen(raw_name
);
517 gchar char_name
[PATH_MAX
];
524 for(i
=raw_name_len
-1;i
>=0;i
--) {
525 if(raw_name
[i
] == '_') break;
527 if(i
==0) /* Either not found or name length is 0 */
531 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
533 if(endptr
== raw_name
+underscore_pos
+1)
534 return -1; /* No digit */
535 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
536 return -1; /* underflow / overflow */
538 strncpy(char_name
, raw_name
, underscore_pos
);
540 *name
= g_quark_from_string(char_name
);
547 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
549 return &trace
->tracefiles
;
553 void compute_tracefile_group(GQuark key_id
,
555 struct compute_tracefile_group_args
*args
)
560 for(i
=0; i
<group
->len
; i
++) {
561 tf
= &g_array_index (group
, LttTracefile
, i
);
563 args
->func(tf
, args
->func_args
);
568 void ltt_tracefile_group_destroy(gpointer data
)
570 GArray
*group
= (GArray
*)data
;
574 for(i
=0; i
<group
->len
; i
++) {
575 tf
= &g_array_index (group
, LttTracefile
, i
);
577 ltt_tracefile_close(tf
);
579 g_array_free(group
, TRUE
);
582 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
584 GArray
*group
= (GArray
*)data
;
588 for(i
=0; i
<group
->len
; i
++) {
589 tf
= &g_array_index (group
, LttTracefile
, i
);
590 if(tf
->cpu_online
) return 1;
596 /* Open each tracefile under a specific directory. Put them in a
597 * GData : permits to access them using their tracefile group pathname.
598 * i.e. access control/modules tracefile group by index :
601 * relative path is the path relative to the trace root
602 * root path is the full path
604 * A tracefile group is simply an array where all the per cpu tracefiles sits.
607 static int open_tracefiles(LttTrace
*trace
, char *root_path
,
610 DIR *dir
= opendir(root_path
);
611 struct dirent
*entry
;
612 struct stat stat_buf
;
620 char rel_path
[PATH_MAX
];
629 strncpy(path
, root_path
, PATH_MAX
-1);
630 path_len
= strlen(path
);
631 path
[path_len
] = '/';
633 path_ptr
= path
+ path_len
;
635 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
636 rel_path_len
= strlen(rel_path
);
637 rel_path
[rel_path_len
] = '/';
639 rel_path_ptr
= rel_path
+ rel_path_len
;
641 while((entry
= readdir(dir
)) != NULL
) {
643 if(entry
->d_name
[0] == '.') continue;
645 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
646 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
648 ret
= stat(path
, &stat_buf
);
654 g_debug("Tracefile file or directory : %s\n", path
);
656 if(S_ISDIR(stat_buf
.st_mode
)) {
658 g_debug("Entering subdirectory...\n");
659 ret
= open_tracefiles(trace
, path
, rel_path
);
660 if(ret
< 0) continue;
661 } else if(S_ISREG(stat_buf
.st_mode
)) {
668 if(get_tracefile_name_number(rel_path
, &name
, &num
))
669 continue; /* invalid name */
671 g_debug("Opening file.\n");
672 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
673 g_info("Error opening tracefile %s", path
);
675 continue; /* error opening the tracefile : bad magic number ? */
678 g_debug("Tracefile name is %s and number is %u",
679 g_quark_to_string(name
), num
);
681 tmp_tf
.cpu_online
= 1;
682 tmp_tf
.cpu_num
= num
;
684 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
686 /* Elements are automatically cleared when the array is allocated.
687 * It makes the cpu_online variable set to 0 : cpu offline, by default.
689 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
690 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
691 group
, ltt_tracefile_group_destroy
);
694 /* Add the per cpu tracefile to the named group */
695 unsigned int old_len
= group
->len
;
697 group
= g_array_set_size(group
, num
+1);
698 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
708 /* ltt_get_facility_description
710 * Opens the trace corresponding to the requested facility (identified by fac_id
713 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
715 * Returns 0 on success, or 1 on failure.
718 static int ltt_get_facility_description(LttFacility
*f
,
720 LttTracefile
*fac_tf
)
722 char desc_file_name
[PATH_MAX
];
727 text
= g_quark_to_string(t
->pathname
);
728 textlen
= strlen(text
);
730 if(textlen
>= PATH_MAX
) goto name_error
;
731 strcpy(desc_file_name
, text
);
733 text
= "/eventdefs/";
734 textlen
+=strlen(text
);
735 if(textlen
>= PATH_MAX
) goto name_error
;
736 strcat(desc_file_name
, text
);
738 text
= g_quark_to_string(f
->name
);
739 textlen
+=strlen(text
);
740 if(textlen
>= PATH_MAX
) goto name_error
;
741 strcat(desc_file_name
, text
);
744 textlen
+=strlen(text
);
745 if(textlen
>= PATH_MAX
) goto name_error
;
746 strcat(desc_file_name
, text
);
748 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
750 if(err
< 0) goto name_error
;
752 textlen
=strlen(desc_file_name
);
755 textlen
+=strlen(text
);
756 if(textlen
>= PATH_MAX
) goto name_error
;
757 strcat(desc_file_name
, text
);
759 err
= ltt_facility_open(f
, t
, desc_file_name
);
760 if(err
) goto facility_error
;
769 static void ltt_fac_ids_destroy(gpointer data
)
771 GArray
*fac_ids
= (GArray
*)data
;
773 g_array_free(fac_ids
, TRUE
);
777 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
778 * because it must be done just after the opening */
779 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
788 err
= ltt_tracefile_read_seek(tf
);
789 if(err
== EPERM
) goto seek_error
;
790 else if(err
== ERANGE
) break; /* End of tracefile */
792 err
= ltt_tracefile_read_update_event(tf
);
793 if(err
) goto update_error
;
795 /* We are on a facility load/or facility unload/ or heartbeat event */
797 * * facility 0 is hardcoded : this is the core facility. It will be shown
798 * in the facility array though, and is shown as "loaded builtin" in the
800 * It contains event :
802 * 1 : facility unload
803 * 2 : state dump facility load
806 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
807 /* Should only contain core facility */
808 g_warning("Error in processing facility file %s, "
809 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
810 tf
->event
.facility_id
);
815 struct LttFacilityLoad
*fac_load_data
;
816 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
820 switch((enum ltt_core_events
)tf
->event
.event_id
) {
821 case LTT_EVENT_FACILITY_LOAD
:
822 fac_name
= (char*)(tf
->event
.data
);
823 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
826 (struct LttFacilityLoad
*)
827 (tf
->event
.data
+ strlen(fac_name
) + 1);
828 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
829 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
830 g_assert(fac
->exists
== 0);
831 fac
->name
= g_quark_from_string(fac_name
);
832 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
833 &fac_load_data
->checksum
);
834 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
835 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
836 &fac_load_data
->pointer_size
);
837 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
838 &fac_load_data
->long_size
);
839 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
840 &fac_load_data
->size_t_size
);
841 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
842 &fac_load_data
->alignment
);
844 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
845 continue; /* error opening description */
847 fac
->trace
= tf
->trace
;
849 /* Preset the field offsets */
850 for(i
=0; i
<fac
->events
->len
; i
++){
851 et
= &g_array_index(fac
->events
, LttEventType
, i
);
852 set_fields_offsets(tf
, et
);
857 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
859 if(fac_ids
== NULL
) {
860 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
861 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
863 fac_ids
, ltt_fac_ids_destroy
);
865 g_array_append_val(fac_ids
, fac
->id
);
868 case LTT_EVENT_FACILITY_UNLOAD
:
869 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
870 /* We don't care about unload : facilities ID are valid for the whole
871 * trace. They simply won't be used after the unload. */
873 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
874 fac_name
= (char*)(tf
->event
.data
);
875 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
877 fac_state_dump_load_data
=
878 (struct LttStateDumpFacilityLoad
*)
879 (tf
->event
.data
+ strlen(fac_name
) + 1);
880 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
881 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
882 g_assert(fac
->exists
== 0);
883 fac
->name
= g_quark_from_string(fac_name
);
884 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
885 &fac_state_dump_load_data
->checksum
);
886 fac
->id
= fac_state_dump_load_data
->id
;
887 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
888 &fac_state_dump_load_data
->pointer_size
);
889 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
890 &fac_state_dump_load_data
->long_size
);
891 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
892 &fac_state_dump_load_data
->size_t_size
);
893 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
894 &fac_state_dump_load_data
->alignment
);
895 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
896 continue; /* error opening description */
898 fac
->trace
= tf
->trace
;
900 /* Preset the field offsets */
901 for(i
=0; i
<fac
->events
->len
; i
++){
902 et
= &g_array_index(fac
->events
, LttEventType
, i
);
903 set_fields_offsets(tf
, et
);
908 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
910 if(fac_ids
== NULL
) {
911 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
912 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
914 fac_ids
, ltt_fac_ids_destroy
);
916 g_array_append_val(fac_ids
, fac
->id
);
919 case LTT_EVENT_HEARTBEAT
:
922 g_warning("Error in processing facility file %s, "
923 "unknown event id %hhu in core facility.",
924 g_quark_to_string(tf
->name
),
939 g_warning("An error occured in facility tracefile parsing");
944 LttTrace
*ltt_trace_open(const gchar
*pathname
)
946 gchar abs_path
[PATH_MAX
];
951 struct ltt_block_start_header
*header
;
953 t
= g_new(LttTrace
, 1);
954 if(!t
) goto alloc_error
;
956 get_absolute_pathname(pathname
, abs_path
);
957 t
->pathname
= g_quark_from_string(abs_path
);
959 /* Open all the tracefiles */
960 g_datalist_init(&t
->tracefiles
);
961 if(open_tracefiles(t
, abs_path
, ""))
964 /* Prepare the facilities containers : array and mapping */
965 /* Array is zeroed : the "exists" field is set to false by default */
966 t
->facilities_by_num
= g_array_sized_new (FALSE
,
967 TRUE
, sizeof(LttFacility
),
969 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
971 g_datalist_init(&t
->facilities_by_name
);
973 /* Parse each trace control/facilitiesN files : get runtime fac. info */
974 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
976 g_error("Trace %s has no facility tracefile", abs_path
);
978 goto facilities_error
;
981 /* Get the trace information for the control/facility 0 tracefile */
982 g_assert(group
->len
> 0);
983 tf
= &g_array_index (group
, LttTracefile
, 0);
984 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
985 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_type
);
986 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_variant
);
987 t
->arch_size
= header
->trace
.arch_size
;
988 t
->ltt_major_version
= header
->trace
.major_version
;
989 t
->ltt_minor_version
= header
->trace
.minor_version
;
990 t
->flight_recorder
= header
->trace
.flight_recorder
;
991 t
->has_heartbeat
= header
->trace
.has_heartbeat
;
992 t
->has_alignment
= header
->trace
.has_alignment
;
993 t
->has_tsc
= header
->trace
.has_tsc
;
996 for(i
=0; i
<group
->len
; i
++) {
997 tf
= &g_array_index (group
, LttTracefile
, i
);
998 if(ltt_process_facility_tracefile(tf
))
999 goto facilities_error
;
1004 /* Error handling */
1006 g_datalist_clear(&t
->facilities_by_name
);
1007 g_array_free(t
->facilities_by_num
, TRUE
);
1009 g_datalist_clear(&t
->tracefiles
);
1016 GQuark
ltt_trace_name(LttTrace
*t
)
1022 /******************************************************************************
1023 * When we copy a trace, we want all the opening actions to happen again :
1024 * the trace will be reopened and totally independant from the original.
1025 * That's why we call ltt_trace_open.
1026 *****************************************************************************/
1027 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1029 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1032 void ltt_trace_close(LttTrace
*t
)
1037 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1038 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1040 ltt_facility_close(fac
);
1043 g_datalist_clear(&t
->facilities_by_name
);
1044 g_array_free(t
->facilities_by_num
, TRUE
);
1045 g_datalist_clear(&t
->tracefiles
);
1050 /*****************************************************************************
1051 *Get the system description of the trace
1052 ****************************************************************************/
1054 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1056 g_assert(id
< t
->facilities_by_num
->len
);
1057 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1060 /* ltt_trace_facility_get_by_name
1062 * Returns the GArray of facility indexes. All the fac_ids that matches the
1063 * requested facility name.
1065 * If name is not found, returns NULL.
1067 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1069 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1072 /*****************************************************************************
1073 * Functions to discover all the event types in the trace
1074 ****************************************************************************/
1077 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1081 unsigned int num
= t
->facility_number
;
1085 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1086 count
+= f
->event_number
;
1093 //use an iteration on all the trace facilities, and inside iteration on all the
1094 //event types in each facilities instead.
1095 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1097 LttEventType
*event_type
;
1100 f
= ltt_trace_facility_by_id(t
,evId
);
1102 if(unlikely(!f
)) event_type
= NULL
;
1103 else event_type
= f
->events
[evId
- f
->base_id
];
1110 /*****************************************************************************
1111 * ltt_trace_find_tracefile
1113 * Find a tracefile by name and index in the group.
1115 * Returns a pointer to the tracefiles, else NULL.
1116 ****************************************************************************/
1118 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1123 /*****************************************************************************
1124 * Get the start time and end time of the trace
1125 ****************************************************************************/
1127 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1128 LttTime
*start
, LttTime
*end
)
1130 struct ltt_block_start_header
* header
;
1133 err
= map_block(tf
, 0);
1135 g_error("Can not map block");
1136 *start
= ltt_time_infinite
;
1138 *start
= tf
->buffer
.begin
.timestamp
;
1140 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1142 g_error("Can not map block");
1143 *end
= ltt_time_zero
;
1145 *end
= tf
->buffer
.end
.timestamp
;
1148 struct tracefile_time_span_get_args
{
1154 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1156 struct tracefile_time_span_get_args
*args
=
1157 (struct tracefile_time_span_get_args
*)user_data
;
1159 GArray
*group
= (GArray
*)data
;
1165 for(i
=0; i
<group
->len
; i
++) {
1166 tf
= &g_array_index (group
, LttTracefile
, i
);
1167 if(tf
->cpu_online
) {
1168 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1169 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1170 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1175 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1177 LttTime min_start
= ltt_time_infinite
;
1178 LttTime max_end
= ltt_time_zero
;
1179 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1181 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1183 if(start
!= NULL
) *start
= min_start
;
1184 if(end
!= NULL
) *end
= max_end
;
1189 /*****************************************************************************
1190 *Get the name of a tracefile
1191 ****************************************************************************/
1193 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1198 /*****************************************************************************
1199 * Get the number of blocks in the tracefile
1200 ****************************************************************************/
1202 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1204 return tf
->num_blocks
;
1208 /* Seek to the first event in a tracefile that has a time equal or greater than
1209 * the time passed in parameter.
1211 * If the time parameter is outside the tracefile time span, seek to the first
1212 * event or if after, return ERANGE.
1214 * If the time parameter is before the first event, we have to seek specially to
1217 * If the time is after the end of the trace, return ERANGE.
1219 * Do a binary search to find the right block, then a sequential search in the
1220 * block to find the event.
1222 * In the special case where the time requested fits inside a block that has no
1223 * event corresponding to the requested time, the first event of the next block
1226 * IMPORTANT NOTE : // FIXME everywhere...
1228 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1229 * you will jump over an event if you do.
1231 * Return value : 0 : no error, the tf->event can be used
1232 * ERANGE : time if after the last event of the trace
1233 * otherwise : this is an error.
1237 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1241 unsigned int block_num
, high
, low
;
1243 /* seek at the beginning of trace */
1244 err
= map_block(tf
, 0); /* First block */
1246 g_error("Can not map block");
1250 /* If the time is lower or equal the beginning of the trace,
1251 * go to the first event. */
1252 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1253 ret
= ltt_tracefile_read(tf
);
1254 if(ret
== ERANGE
) goto range
;
1255 else if (ret
) goto fail
;
1256 goto found
; /* There is either no event in the trace or the event points
1257 to the first event in the trace */
1260 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1262 g_error("Can not map block");
1266 /* If the time is after the end of the trace, return ERANGE. */
1267 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1271 /* Binary search the block */
1272 high
= tf
->num_blocks
- 1;
1276 block_num
= ((high
-low
) / 2) + low
;
1278 err
= map_block(tf
, block_num
);
1280 g_error("Can not map block");
1284 /* We cannot divide anymore : this is what would happen if the time
1285 * requested was exactly between two consecutive buffers'end and start
1286 * timestamps. This is also what would happend if we didn't deal with out
1287 * of span cases prior in this function. */
1288 /* The event is right in the buffer!
1289 * (or in the next buffer first event) */
1291 ret
= ltt_tracefile_read(tf
);
1292 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1293 else if(ret
) goto fail
;
1295 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1299 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1300 /* go to lower part */
1302 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1303 /* go to higher part */
1305 } else {/* The event is right in the buffer!
1306 (or in the next buffer first event) */
1308 ret
= ltt_tracefile_read(tf
);
1309 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1310 else if(ret
) goto fail
;
1312 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1324 /* Error handling */
1326 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1327 g_quark_to_string(tf
->name
));
1332 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1336 if(ep
->tracefile
!= tf
) {
1340 err
= map_block(tf
, ep
->block
);
1342 g_error("Can not map block");
1346 tf
->event
.offset
= ep
->offset
;
1348 err
= ltt_tracefile_read_update_event(tf
);
1350 err
= ltt_tracefile_read_op(tf
);
1356 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1357 g_quark_to_string(tf
->name
));
1360 /* Calculate the real event time based on the buffer boundaries */
1361 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1365 g_assert(tf
->trace
->has_tsc
);
1367 time
= ltt_time_from_uint64(
1368 (guint64
)tf
->buffer
.tsc
*tf
->buffer
.nsecs_per_cycle
);
1369 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1375 /* Get the current event of the tracefile : valid until the next read */
1376 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1383 /*****************************************************************************
1385 * ltt_tracefile_read : Read the next event in the tracefile
1390 * Returns 0 if an event can be used in tf->event.
1391 * Returns ERANGE on end of trace. The event in tf->event still can be used.
1392 * Returns EPERM on error.
1394 * This function does make the tracefile event structure point to the event
1395 * currently pointed to by the tf->event.
1397 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1398 * reinitialize it after an error if you want results to be coherent.
1399 * It would be the case if a end of trace last buffer has no event : the end
1400 * of trace wouldn't be returned, but an error.
1401 * We make the assumption there is at least one event per buffer.
1402 ****************************************************************************/
1404 int ltt_tracefile_read(LttTracefile
*tf
)
1408 err
= ltt_tracefile_read_seek(tf
);
1410 err
= ltt_tracefile_read_update_event(tf
);
1412 err
= ltt_tracefile_read_op(tf
);
1418 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1422 /* Get next buffer until we finally have an event, or end of trace */
1424 err
= ltt_seek_next_event(tf
);
1425 if(unlikely(err
== ENOPROTOOPT
)) {
1429 /* Are we at the end of the buffer ? */
1431 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1434 /* get next block */
1435 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1437 g_error("Can not map block");
1441 } else break; /* We found an event ! */
1448 /* do specific operation on events */
1449 int ltt_tracefile_read_op(LttTracefile
*tf
)
1458 /* do event specific operation */
1460 /* do something if its an heartbeat event : increment the heartbeat count */
1461 //if(event->facility_id == LTT_FACILITY_CORE)
1462 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1463 // tf->cur_heart_beat_number++;
1469 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1470 * event specific operation. */
1471 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1479 pos
= tf
->buffer
.head
+ event
->offset
;
1481 /* Read event header */
1485 if(tf
->trace
->has_tsc
) {
1486 if(tf
->trace
->has_heartbeat
) {
1487 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1489 /* 32 bits -> 64 bits tsc */
1490 /* note : still works for seek and non seek cases. */
1491 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1492 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1494 | (guint64
)event
->time
.timestamp
;
1495 event
->tsc
= tf
->buffer
.tsc
;
1498 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1499 | (guint64
)event
->time
.timestamp
;
1500 event
->tsc
= tf
->buffer
.tsc
;
1502 pos
+= sizeof(guint32
);
1504 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1505 tf
->buffer
.tsc
= event
->tsc
;
1506 pos
+= sizeof(guint64
);
1509 event
->event_time
= ltt_interpolate_time(tf
, event
);
1511 event
->time
.delta
.tv_sec
= 0;
1512 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1513 pos
) * NSEC_PER_USEC
;
1515 event
->tsc
= tf
->buffer
.tsc
;
1517 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1519 pos
+= sizeof(guint32
);
1522 event
->facility_id
= *(guint8
*)pos
;
1523 pos
+= sizeof(guint8
);
1525 event
->event_id
= *(guint8
*)pos
;
1526 pos
+= sizeof(guint8
);
1528 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1529 pos
+= sizeof(guint16
);
1533 /* get the data size and update the event fields with the current
1535 ltt_update_event_size(tf
);
1541 /****************************************************************************
1543 * map_block : map a block from the file
1545 * lttdes : ltt trace file
1546 * whichBlock : the block which will be read
1549 * EINVAL : lseek fail
1550 * EIO : can not read from the file
1551 ****************************************************************************/
1553 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1555 int page_size
= getpagesize();
1556 struct ltt_block_start_header
*header
;
1558 g_assert(block_num
< tf
->num_blocks
);
1560 if(tf
->buffer
.head
!= NULL
)
1561 munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
));
1563 /* Multiple of pages aligned head */
1564 tf
->buffer
.head
= mmap(0,
1565 PAGE_ALIGN(tf
->block_size
),
1566 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1567 PAGE_ALIGN((off_t
)tf
->block_size
* (off_t
)block_num
));
1569 if(tf
->buffer
.head
== MAP_FAILED
) {
1570 perror("Error in allocating memory for buffer of tracefile");
1574 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1577 tf
->buffer
.index
= block_num
;
1579 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1581 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1582 &header
->begin
.timestamp
);
1583 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1584 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1585 &header
->begin
.cycle_count
);
1586 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1587 &header
->end
.timestamp
);
1588 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1589 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1590 &header
->end
.cycle_count
);
1591 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1592 &header
->lost_size
);
1594 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1595 tf
->event
.tsc
= tf
->buffer
.tsc
;
1598 * eventually support variable buffer size : will need a partial pre-read of
1599 * the headers to create an index when we open the trace... eventually. */
1600 g_assert(tf
->block_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1601 &header
->buf_size
));
1603 /* Now that the buffer is mapped, calculate the time interpolation for the
1606 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1608 /* Make the current event point to the beginning of the buffer :
1609 * it means that the event read must get the first event. */
1610 tf
->event
.tracefile
= tf
;
1611 tf
->event
.block
= block_num
;
1612 tf
->event
.offset
= 0;
1621 /* It will update the fields offsets too */
1622 void ltt_update_event_size(LttTracefile
*tf
)
1626 /* Specific handling of core events : necessary to read the facility control
1628 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1629 tf
->event
.facility_id
);
1631 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1632 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1633 case LTT_EVENT_FACILITY_LOAD
:
1634 size
= strlen((char*)tf
->event
.data
) + 1;
1635 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1636 size
+= sizeof(struct LttFacilityLoad
);
1638 case LTT_EVENT_FACILITY_UNLOAD
:
1639 g_debug("Update Event facility unload");
1640 size
= sizeof(struct LttFacilityUnload
);
1642 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1643 size
= strlen((char*)tf
->event
.data
) + 1;
1644 g_debug("Update Event facility load state dump of facility %s",
1645 (char*)tf
->event
.data
);
1646 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1648 case LTT_EVENT_HEARTBEAT
:
1649 g_debug("Update Event heartbeat");
1650 size
= sizeof(TimeHeartbeat
);
1653 g_warning("Error in getting event size : tracefile %s, "
1654 "unknown event id %hhu in core facility.",
1655 g_quark_to_string(tf
->name
),
1656 tf
->event
.event_id
);
1657 goto event_id_error
;
1662 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1663 tf
->event
.facility_id
,
1664 tf
->event
.facility_id
,
1665 g_quark_to_string(tf
->name
));
1666 goto facility_error
;
1669 LttEventType
*event_type
=
1670 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1673 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1675 g_quark_to_string(f
->name
),
1676 g_quark_to_string(tf
->name
));
1677 goto event_type_error
;
1680 if(event_type
->root_field
)
1681 size
= get_field_type_size(tf
, event_type
,
1682 0, 0, event_type
->root_field
, tf
->event
.data
);
1686 g_debug("Event root field : f.e %hhu.%hhu size %lu", tf
->event
.facility_id
,
1687 tf
->event
.event_id
, size
);
1690 tf
->event
.data_size
= size
;
1692 /* Check consistency between kernel and LTTV structure sizes */
1693 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1700 tf
->event
.data_size
= 0;
1704 /* Take the tf current event offset and use the event facility id and event id
1705 * to figure out where is the next event offset.
1707 * This is an internal function not aiming at being used elsewhere : it will
1708 * not jump over the current block limits. Please consider using
1709 * ltt_tracefile_read to do this.
1711 * Returns 0 on success
1712 * ERANGE if we are at the end of the buffer.
1713 * ENOPROTOOPT if an error occured when getting the current event size.
1715 static int ltt_seek_next_event(LttTracefile
*tf
)
1721 /* seek over the buffer header if we are at the buffer start */
1722 if(tf
->event
.offset
== 0) {
1723 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
);
1725 if(tf
->event
.offset
== tf
->block_size
- tf
->buffer
.lost_size
) {
1732 pos
= tf
->event
.data
;
1734 if(tf
->event
.data_size
< 0) goto error
;
1736 pos
+= (size_t)tf
->event
.data_size
;
1738 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1740 if(tf
->event
.offset
== tf
->block_size
- tf
->buffer
.lost_size
) {
1749 g_error("Error in ltt_seek_next_event for tracefile %s",
1750 g_quark_to_string(tf
->name
));
1755 /*****************************************************************************
1757 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1760 ****************************************************************************/
1762 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1764 LttTime lBufTotalTime
; /* Total time for this buffer */
1765 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1766 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1768 /* Calculate the total time for this buffer */
1769 lBufTotalTime
= ltt_time_sub(
1770 ltt_get_time(LTT_GET_BO(tf
), &tf
->buffer
.end
.timestamp
),
1771 ltt_get_time(LTT_GET_BO(tf
), &tf
->buffer
.begin
.timestamp
));
1773 /* Calculate the total cycles for this bufffer */
1774 lBufTotalCycle
= ltt_get_uint64(LTT_GET_BO(tf
), &tf
->buffer
.end
.cycle_count
);
1775 lBufTotalCycle
-= ltt_get_uint64(LTT_GET_BO(tf
),
1776 &tf
->buffer
.begin
.cycle_count
);
1778 /* Convert the total time to double */
1779 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1781 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1785 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1787 LttField
* rootFld
= evT
->root_field
;
1788 // rootFld->base_address = evD;
1791 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1792 evT
, 0,0,rootFld
, evD
);
1796 /*****************************************************************************
1798 * set_fields_offsets : set the precomputable offset of the fields
1800 * tracefile : opened trace file
1801 * event_type : the event type
1802 ****************************************************************************/
1804 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1806 LttField
*field
= event_type
->root_field
;
1807 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1810 preset_field_type_size(tf
, event_type
, 0, 0,
1811 &fixed_root
, &fixed_parent
,
1817 /*****************************************************************************
1819 * preset_field_type_size : set the fixed sizes of the field type
1822 * event_type : event type
1823 * offset_root : offset from the root
1824 * offset_parent : offset from the parent
1825 * fixed_root : Do we know a fixed offset to the root ?
1826 * fixed_parent : Do we know a fixed offset to the parent ?
1828 ****************************************************************************/
1829 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1830 off_t offset_root
, off_t offset_parent
,
1831 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1834 enum field_status local_fixed_root
, local_fixed_parent
;
1838 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1839 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1840 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1842 type
= field
->field_type
;
1844 field
->fixed_root
= *fixed_root
;
1845 if(field
->fixed_root
== FIELD_FIXED
)
1846 field
->offset_root
= offset_root
;
1848 field
->offset_root
= 0;
1850 field
->fixed_parent
= *fixed_parent
;
1851 if(field
->fixed_parent
== FIELD_FIXED
)
1852 field
->offset_parent
= offset_parent
;
1854 field
->offset_parent
= 0;
1856 size_t current_root_offset
;
1857 size_t current_offset
;
1858 enum field_status current_child_status
, final_child_status
;
1861 switch(type
->type_class
) {
1866 field
->field_size
= ltt_type_size(tf
->trace
, type
);
1867 field
->fixed_size
= FIELD_FIXED
;
1870 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
1871 field
->fixed_size
= FIELD_FIXED
;
1875 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
1876 field
->fixed_size
= FIELD_FIXED
;
1881 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
1882 field
->fixed_size
= FIELD_FIXED
;
1885 local_fixed_root
= FIELD_VARIABLE
;
1886 local_fixed_parent
= FIELD_VARIABLE
;
1887 preset_field_type_size(tf
, event_type
,
1889 &local_fixed_root
, &local_fixed_parent
,
1891 field
->fixed_size
= FIELD_VARIABLE
;
1892 field
->field_size
= 0;
1893 *fixed_root
= FIELD_VARIABLE
;
1894 *fixed_parent
= FIELD_VARIABLE
;
1897 field
->fixed_size
= FIELD_VARIABLE
;
1898 field
->field_size
= 0;
1899 *fixed_root
= FIELD_VARIABLE
;
1900 *fixed_parent
= FIELD_VARIABLE
;
1903 local_fixed_root
= FIELD_VARIABLE
;
1904 local_fixed_parent
= FIELD_VARIABLE
;
1905 preset_field_type_size(tf
, event_type
,
1907 &local_fixed_root
, &local_fixed_parent
,
1909 field
->fixed_size
= field
->child
[0]->fixed_size
;
1910 if(field
->fixed_size
== FIELD_FIXED
) {
1911 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
1913 field
->field_size
= 0;
1914 *fixed_root
= FIELD_VARIABLE
;
1915 *fixed_parent
= FIELD_VARIABLE
;
1919 current_root_offset
= field
->offset_root
;
1921 current_child_status
= FIELD_FIXED
;
1922 for(i
=0;i
<type
->element_number
;i
++) {
1923 preset_field_type_size(tf
, event_type
,
1924 current_root_offset
, current_offset
,
1925 fixed_root
, ¤t_child_status
,
1927 if(current_child_status
== FIELD_FIXED
) {
1928 current_root_offset
+= field
->child
[i
]->field_size
;
1929 current_offset
+= field
->child
[i
]->field_size
;
1931 current_root_offset
= 0;
1935 if(current_child_status
!= FIELD_FIXED
) {
1936 *fixed_parent
= current_child_status
;
1937 field
->field_size
= 0;
1938 field
->fixed_size
= current_child_status
;
1940 field
->field_size
= current_offset
;
1941 field
->fixed_size
= FIELD_FIXED
;
1945 current_root_offset
= field
->offset_root
;
1948 final_child_status
= FIELD_FIXED
;
1949 for(i
=0;i
<type
->element_number
;i
++) {
1950 enum field_status current_root_child_status
= FIELD_FIXED
;
1951 enum field_status current_child_status
= FIELD_FIXED
;
1952 preset_field_type_size(tf
, event_type
,
1953 current_root_offset
, current_offset
,
1954 ¤t_root_child_status
, ¤t_child_status
,
1956 if(current_child_status
!= FIELD_FIXED
)
1957 final_child_status
= current_child_status
;
1959 max_size
= max(max_size
, field
->child
[i
]->field_size
);
1961 if(final_child_status
!= FIELD_FIXED
) {
1962 *fixed_root
= final_child_status
;
1963 *fixed_parent
= final_child_status
;
1964 field
->field_size
= 0;
1965 field
->fixed_size
= current_child_status
;
1967 field
->field_size
= max_size
;
1968 field
->fixed_size
= FIELD_FIXED
;
1976 /*****************************************************************************
1978 * check_fields_compatibility : Check for compatibility between two fields :
1979 * do they use the same inner structure ?
1981 * event_type1 : event type
1982 * event_type2 : event type
1985 *Returns : 0 if identical
1987 ****************************************************************************/
1988 gint
check_fields_compatibility(LttEventType
*event_type1
,
1989 LttEventType
*event_type2
,
1990 LttField
*field1
, LttField
*field2
)
1992 guint different
= 0;
1993 enum field_status local_fixed_root
, local_fixed_parent
;
1998 if(field1
== NULL
) {
1999 if(field2
== NULL
) goto end
;
2004 } else if(field2
== NULL
) {
2009 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2010 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2011 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2012 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2013 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2014 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2016 type1
= field1
->field_type
;
2017 type2
= field2
->field_type
;
2019 size_t current_root_offset
;
2020 size_t current_offset
;
2021 enum field_status current_child_status
, final_child_status
;
2024 if(type1
->type_class
!= type2
->type_class
) {
2028 if(type1
->element_name
!= type2
->element_name
) {
2033 switch(type1
->type_class
) {
2043 if(field1
->field_size
!= field2
->field_size
) {
2049 if(type1
->element_number
!= type2
->element_number
) {
2053 for(i
=0;i
<type1
->element_number
;i
++) {
2054 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2061 /* Two elements : size and child */
2062 g_assert(type1
->element_number
!= type2
->element_number
);
2063 for(i
=0;i
<type1
->element_number
;i
++) {
2064 if(check_fields_compatibility(event_type1
, event_type2
,
2065 field1
->child
[0], field2
->child
[0])) {
2074 if(field1
->field_size
!= field2
->field_size
) {
2078 /* Two elements : size and child */
2079 g_assert(type1
->element_number
!= type2
->element_number
);
2080 for(i
=0;i
<type1
->element_number
;i
++) {
2081 if(check_fields_compatibility(event_type1
, event_type2
,
2082 field1
->child
[0], field2
->child
[0])) {
2090 if(type1
->element_number
!= type2
->element_number
) {
2094 for(i
=0;i
<type1
->element_number
;i
++) {
2095 if(check_fields_compatibility(event_type1
, event_type2
,
2096 field1
->child
[0], field2
->child
[0])) {
2111 /*****************************************************************************
2113 * getFieldtypeSize: get the size of the field type (primitive type)
2116 * offsetRoot : offset from the root
2117 * offsetParent : offset from the parrent
2119 * evD : event data, it may be NULL
2121 * int : size of the field
2122 ****************************************************************************/
2124 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2125 LttEventType
* evT
, gint offsetRoot
,
2126 gint offsetParent
, LttField
* fld
, void *evD
)
2128 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2129 LttType
* type
= fld
->field_type
;
2131 /* This likely has been tested with gcov : half of them.. */
2132 if(unlikely(fld
->field_fixed
== 1)){
2134 if(unlikely(fld
== evT
->root_field
)) {
2135 size
= fld
->field_size
;
2136 goto end_getFieldtypeSize
;
2140 /* From gcov profiling : half string, half struct, can we gain something
2141 * from that ? (Mathieu) */
2142 switch(type
->type_class
) {
2144 element_number
= (int) type
->element_number
;
2145 if(fld
->field_fixed
== -1){
2146 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2147 0,fld
->child
[0], NULL
);
2148 if(size
== 0){ //has string or sequence
2149 fld
->field_fixed
= 0;
2151 fld
->field_fixed
= 1;
2152 size
*= element_number
;
2154 }else if(fld
->field_fixed
== 0){// has string or sequence
2156 for(i
=0;i
<element_number
;i
++){
2157 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2158 fld
->child
[0], evD
+size
);
2160 }else size
= fld
->field_size
;
2162 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2163 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2169 size1
= (int) ltt_type_size(fac
, type
);
2170 if(fld
->field_fixed
== -1){
2171 fld
->sequ_number_size
= size1
;
2172 fld
->field_fixed
= 0;
2173 size
= getFieldtypeSize(evT
, offsetRoot
,
2174 0,fld
->child
[0], NULL
);
2175 fld
->element_size
= size
;
2177 element_number
= getIntNumber(tf
,size1
,evD
);
2178 type
->element_number
= element_number
;
2179 if(fld
->element_size
> 0){
2180 size
= element_number
* fld
->element_size
;
2181 }else{//sequence has string or sequence
2183 for(i
=0;i
<element_number
;i
++){
2184 size
+= getFieldtypeSize(tf
, evT
,
2185 offsetRoot
+size
+size1
,size
+size1
,
2186 fld
->child
[0], evD
+size
+size1
);
2192 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2193 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2200 if(fld
->field_fixed
== -1){
2201 fld
->field_fixed
= 0;
2203 /* Hope my implementation is faster than strlen (Mathieu) */
2204 char *ptr
=(char*)evD
;
2206 /* from gcov : many many strings are empty, make it the common case.*/
2207 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2208 //size = ptr - (char*)evD + 1; //include end : '\0'
2210 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2211 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2216 element_number
= (int) type
->element_number
;
2218 /* tested with gcov */
2219 if(unlikely(fld
->field_fixed
== -1)){
2220 offset1
= offsetRoot
;
2222 for(i
=0;i
<element_number
;i
++){
2223 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2224 fld
->child
[i
], NULL
);
2225 if(likely(size1
> 0 && size
>= 0)){
2227 if(likely(offset1
>= 0)) offset1
+= size1
;
2235 if(unlikely(size
== -1)){
2236 fld
->field_fixed
= 0;
2238 }else fld
->field_fixed
= 1;
2239 }else if(likely(fld
->field_fixed
== 0)){
2240 offset1
= offsetRoot
;
2242 for(i
=0;unlikely(i
<element_number
);i
++){
2243 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2244 fld
->child
[i
], evD
+offset2
);
2249 }else size
= fld
->field_size
;
2250 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2251 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2255 if(unlikely(fld
->field_fixed
== -1)){
2256 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2257 fld
->field_fixed
= 1;
2258 }else size
= fld
->field_size
;
2260 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2261 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2266 fld
->offset_root
= offsetRoot
;
2267 fld
->offset_parent
= offsetParent
;
2268 fld
->field_size
= size
;
2270 end_getFieldtypeSize
:
2276 /*****************************************************************************
2278 * ltt_get_int : get an integer number
2280 * reverse_byte_order: must we reverse the byte order ?
2281 * size : the size of the integer
2282 * ptr : the data pointer
2284 * gint64 : a 64 bits integer
2285 ****************************************************************************/
2287 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2292 case 1: val
= *((gint8
*)data
); break;
2293 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2294 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2295 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2296 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2297 g_critical("get_int : integer size %d unknown", size
);
2304 /*****************************************************************************
2306 * ltt_get_uint : get an unsigned integer number
2308 * reverse_byte_order: must we reverse the byte order ?
2309 * size : the size of the integer
2310 * ptr : the data pointer
2312 * guint64 : a 64 bits unsigned integer
2313 ****************************************************************************/
2315 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2320 case 1: val
= *((gint8
*)data
); break;
2321 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2322 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2323 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2324 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2325 g_critical("get_uint : unsigned integer size %d unknown",
2334 /* get the node name of the system */
2336 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2338 return s
->node_name
;
2342 /* get the domain name of the system */
2344 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2346 return s
->domain_name
;
2350 /* get the description of the system */
2352 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2354 return s
->description
;
2358 /* get the start time of the trace */
2360 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2362 return s
->trace_start
;
2366 LttTracefile
*ltt_tracefile_new()
2368 return g_new(LttTracefile
, 1);
2371 void ltt_tracefile_destroy(LttTracefile
*tf
)
2376 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2381 /* Before library loading... */
2383 static void __attribute__((constructor
)) init(void)
2385 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2386 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2388 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");