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
)
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
->long_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 ! */
251 /* Get float byte order : might be different from int byte order
252 * (or is set to 0 if the trace has no float (kernel trace)) */
253 tf
->float_word_order
= header
->trace
.float_word_order
;
255 //store the size of the file
256 tf
->file_size
= lTDFStat
.st_size
;
257 tf
->buf_size
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->buf_size
);
258 tf
->num_blocks
= tf
->file_size
/ tf
->buf_size
;
260 if(munmap(tf
->buffer
.head
,
261 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
262 g_warning("unmap size : %u\n",
263 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
264 perror("munmap error");
267 tf
->buffer
.head
= NULL
;
269 //read the first block
270 if(map_block(tf
,0)) {
271 perror("Cannot map block for tracefile");
279 if(munmap(tf
->buffer
.head
,
280 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)))) {
281 g_warning("unmap size : %u\n",
282 PAGE_ALIGN(sizeof(struct ltt_block_start_header
)));
283 perror("munmap error");
292 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
298 /*****************************************************************************
299 *Open control and per cpu tracefiles
300 ****************************************************************************/
302 void ltt_tracefile_open_cpu(LttTrace
*t
, gchar
* tracefile_name
)
305 tf
= ltt_tracefile_open(t
,tracefile_name
);
307 t
->per_cpu_tracefile_number
++;
308 g_ptr_array_add(t
->per_cpu_tracefiles
, tf
);
311 gint
ltt_tracefile_open_control(LttTrace
*t
, gchar
* control_name
)
320 tf
= ltt_tracefile_open(t
,control_name
);
322 g_warning("ltt_tracefile_open_control : bad file descriptor");
325 t
->control_tracefile_number
++;
326 g_ptr_array_add(t
->control_tracefiles
,tf
);
328 //parse facilities tracefile to get base_id
329 if(strcmp(&control_name
[strlen(control_name
)-10],"facilities") ==0){
331 if(!ltt_tracefile_read(tf
,&ev
)) return 0; // end of file
333 if(ev
.event_id
== TRACE_FACILITY_LOAD
){
335 fLoad
.name
= (gchar
*)pos
;
336 fLoad
.checksum
= *(LttChecksum
*)(pos
+ strlen(fLoad
.name
));
337 fLoad
.base_code
= *(guint32
*)(pos
+ strlen(fLoad
.name
) + sizeof(LttChecksum
));
339 for(i
=0;i
<t
->facility_number
;i
++){
340 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
,i
);
341 if(strcmp(f
->name
,fLoad
.name
)==0 && fLoad
.checksum
==f
->checksum
){
342 f
->base_id
= fLoad
.base_code
;
346 if(i
==t
->facility_number
) {
347 g_warning("Facility: %s, checksum: %u is not found",
348 fLoad
.name
,(unsigned int)fLoad
.checksum
);
351 }else if(ev
.event_id
== TRACE_BLOCK_START
){
353 }else if(ev
.event_id
== TRACE_BLOCK_END
){
356 g_warning("Not valid facilities trace file");
365 /*****************************************************************************
367 * ltt_tracefile_close: close a trace file,
369 * t : tracefile which will be closed
370 ****************************************************************************/
372 void ltt_tracefile_close(LttTracefile
*t
)
374 int page_size
= getpagesize();
376 if(t
->buffer
.head
!= NULL
)
377 if(munmap(t
->buffer
.head
, PAGE_ALIGN(t
->buf_size
))) {
378 g_warning("unmap size : %u\n",
379 PAGE_ALIGN(t
->buf_size
));
380 perror("munmap error");
388 /*****************************************************************************
389 *Get system information
390 ****************************************************************************/
392 gint
getSystemInfo(LttSystemDescription
* des
, gchar
* pathname
)
399 GMarkupParseContext
* context
;
400 GError
* error
= NULL
;
401 GMarkupParser markup_parser
=
403 parser_start_element
,
406 NULL
, /* passthrough */
410 fd
= g_open(pathname
, O_RDONLY
, 0);
412 g_warning("Can not open file : %s\n", pathname
);
416 iochan
= g_io_channel_unix_new(fd
);
418 context
= g_markup_parse_context_new(&markup_parser
, 0, des
,NULL
);
420 //while(fgets(buf,DIR_NAME_SIZE, fp) != NULL){
421 while(g_io_channel_read_line(iochan
, &buf
, &length
, NULL
, &error
)
422 != G_IO_STATUS_EOF
) {
425 g_warning("Can not read xml file: \n%s\n", error
->message
);
428 if(!g_markup_parse_context_parse(context
, buf
, length
, &error
)){
430 g_warning("Can not parse xml file: \n%s\n", error
->message
);
433 g_markup_parse_context_free(context
);
435 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
437 g_warning("Can not close file: \n%s\n", error
->message
);
445 g_markup_parse_context_free(context
);
447 g_io_channel_shutdown(iochan
, FALSE
, &error
); /* No flush */
449 g_warning("Can not close file: \n%s\n", error
->message
);
460 /*****************************************************************************
461 *The following functions get facility/tracefile information
462 ****************************************************************************/
464 gint
getFacilityInfo(LttTrace
*t
, gchar
* eventdefs
)
471 gchar fullname
[DIR_NAME_SIZE
];
472 GError
* error
= NULL
;
474 dir
= g_dir_open(eventdefs
, 0, &error
);
477 g_warning("Can not open directory: %s, %s\n", eventdefs
, error
->message
);
482 while((name
= g_dir_read_name(dir
)) != NULL
){
483 if(!g_pattern_match_simple("*.xml", name
)) continue;
484 strcpy(fullname
,eventdefs
);
485 strcat(fullname
,name
);
486 ltt_facility_open(t
,fullname
);
490 for(j
=0;j
<t
->facility_number
;j
++){
491 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, j
);
492 for(i
=0; i
<f
->event_number
; i
++){
494 setFieldsOffset(NULL
, et
, NULL
, t
);
501 /*****************************************************************************
502 *A trace is specified as a pathname to the directory containing all the
503 *associated data (control tracefiles, per cpu tracefiles, event
506 *When a trace is closed, all the associated facilities, types and fields
507 *are released as well.
511 /****************************************************************************
512 * get_absolute_pathname
514 * return the unique pathname in the system
516 * MD : Fixed this function so it uses realpath, dealing well with
517 * forgotten cases (.. were not used correctly before).
519 ****************************************************************************/
520 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
)
522 abs_pathname
[0] = '\0';
524 if ( realpath (pathname
, abs_pathname
) != NULL
)
528 /* error, return the original path unmodified */
529 strcpy(abs_pathname
, pathname
);
535 /* Search for something like : .*_.*
537 * The left side is the name, the right side is the number.
540 int get_tracefile_name_number(const gchar
*raw_name
,
544 guint raw_name_len
= strlen(raw_name
);
545 gchar char_name
[PATH_MAX
];
551 for(i
=raw_name_len
-1;i
>=0;i
--) {
552 if(raw_name
[i
] == '_') break;
554 if(i
==0) /* Either not found or name length is 0 */
558 cpu_num
= strtol(raw_name
+underscore_pos
+1, &endptr
, 10);
560 if(endptr
== raw_name
+underscore_pos
+1)
561 return -1; /* No digit */
562 if(cpu_num
== LONG_MIN
|| cpu_num
== LONG_MAX
)
563 return -1; /* underflow / overflow */
565 strncpy(char_name
, raw_name
, underscore_pos
);
567 char_name
[underscore_pos
] = '\0';
569 *name
= g_quark_from_string(char_name
);
576 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
)
578 return &trace
->tracefiles
;
582 void compute_tracefile_group(GQuark key_id
,
584 struct compute_tracefile_group_args
*args
)
589 for(i
=0; i
<group
->len
; i
++) {
590 tf
= &g_array_index (group
, LttTracefile
, i
);
592 args
->func(tf
, args
->func_args
);
597 void ltt_tracefile_group_destroy(gpointer data
)
599 GArray
*group
= (GArray
*)data
;
603 for(i
=0; i
<group
->len
; i
++) {
604 tf
= &g_array_index (group
, LttTracefile
, i
);
606 ltt_tracefile_close(tf
);
608 g_array_free(group
, TRUE
);
611 gboolean
ltt_tracefile_group_has_cpu_online(gpointer data
)
613 GArray
*group
= (GArray
*)data
;
617 for(i
=0; i
<group
->len
; i
++) {
618 tf
= &g_array_index (group
, LttTracefile
, i
);
619 if(tf
->cpu_online
) return 1;
625 /* Open each tracefile under a specific directory. Put them in a
626 * GData : permits to access them using their tracefile group pathname.
627 * i.e. access control/modules tracefile group by index :
630 * relative path is the path relative to the trace root
631 * root path is the full path
633 * A tracefile group is simply an array where all the per cpu tracefiles sits.
636 static int open_tracefiles(LttTrace
*trace
, gchar
*root_path
,
637 gchar
*relative_path
)
639 DIR *dir
= opendir(root_path
);
640 struct dirent
*entry
;
641 struct stat stat_buf
;
644 gchar path
[PATH_MAX
];
649 gchar rel_path
[PATH_MAX
];
658 strncpy(path
, root_path
, PATH_MAX
-1);
659 path_len
= strlen(path
);
660 path
[path_len
] = '/';
662 path_ptr
= path
+ path_len
;
664 strncpy(rel_path
, relative_path
, PATH_MAX
-1);
665 rel_path_len
= strlen(rel_path
);
666 rel_path
[rel_path_len
] = '/';
668 rel_path_ptr
= rel_path
+ rel_path_len
;
670 while((entry
= readdir(dir
)) != NULL
) {
672 if(entry
->d_name
[0] == '.') continue;
674 strncpy(path_ptr
, entry
->d_name
, PATH_MAX
- path_len
);
675 strncpy(rel_path_ptr
, entry
->d_name
, PATH_MAX
- rel_path_len
);
677 ret
= stat(path
, &stat_buf
);
683 g_debug("Tracefile file or directory : %s\n", path
);
685 if(strcmp(rel_path
, "/eventdefs") == 0) continue;
687 if(S_ISDIR(stat_buf
.st_mode
)) {
689 g_debug("Entering subdirectory...\n");
690 ret
= open_tracefiles(trace
, path
, rel_path
);
691 if(ret
< 0) continue;
692 } else if(S_ISREG(stat_buf
.st_mode
)) {
697 if(get_tracefile_name_number(rel_path
, &name
, &num
))
698 continue; /* invalid name */
700 g_debug("Opening file.\n");
701 if(ltt_tracefile_open(trace
, path
, &tmp_tf
)) {
702 g_info("Error opening tracefile %s", path
);
704 continue; /* error opening the tracefile : bad magic number ? */
707 g_debug("Tracefile name is %s and number is %u",
708 g_quark_to_string(name
), num
);
710 tmp_tf
.cpu_online
= 1;
711 tmp_tf
.cpu_num
= num
;
714 group
= g_datalist_id_get_data(&trace
->tracefiles
, name
);
716 /* Elements are automatically cleared when the array is allocated.
717 * It makes the cpu_online variable set to 0 : cpu offline, by default.
719 group
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttTracefile
), 10);
720 g_datalist_id_set_data_full(&trace
->tracefiles
, name
,
721 group
, ltt_tracefile_group_destroy
);
724 /* Add the per cpu tracefile to the named group */
725 unsigned int old_len
= group
->len
;
727 group
= g_array_set_size(group
, num
+1);
728 g_array_index (group
, LttTracefile
, num
) = tmp_tf
;
738 /* ltt_get_facility_description
740 * Opens the trace corresponding to the requested facility (identified by fac_id
743 * The name searched is : %trace root%/eventdefs/facname_checksum.xml
745 * Returns 0 on success, or 1 on failure.
748 static int ltt_get_facility_description(LttFacility
*f
,
750 LttTracefile
*fac_tf
)
752 char desc_file_name
[PATH_MAX
];
757 text
= g_quark_to_string(t
->pathname
);
758 textlen
= strlen(text
);
760 if(textlen
>= PATH_MAX
) goto name_error
;
761 strcpy(desc_file_name
, text
);
763 text
= "/eventdefs/";
764 textlen
+=strlen(text
);
765 if(textlen
>= PATH_MAX
) goto name_error
;
766 strcat(desc_file_name
, text
);
768 text
= g_quark_to_string(f
->name
);
769 textlen
+=strlen(text
);
770 if(textlen
>= PATH_MAX
) goto name_error
;
771 strcat(desc_file_name
, text
);
774 textlen
+=strlen(text
);
775 if(textlen
>= PATH_MAX
) goto name_error
;
776 strcat(desc_file_name
, text
);
778 err
= snprintf(desc_file_name
+textlen
, PATH_MAX
-textlen
-1,
780 if(err
< 0) goto name_error
;
782 textlen
=strlen(desc_file_name
);
785 textlen
+=strlen(text
);
786 if(textlen
>= PATH_MAX
) goto name_error
;
787 strcat(desc_file_name
, text
);
789 err
= ltt_facility_open(f
, t
, desc_file_name
);
790 if(err
) goto facility_error
;
799 static void ltt_fac_ids_destroy(gpointer data
)
801 GArray
*fac_ids
= (GArray
*)data
;
803 g_array_free(fac_ids
, TRUE
);
807 /* Presumes the tracefile is already seeked at the beginning. It makes sense,
808 * because it must be done just after the opening */
809 static int ltt_process_facility_tracefile(LttTracefile
*tf
)
818 err
= ltt_tracefile_read_seek(tf
);
819 if(err
== EPERM
) goto seek_error
;
820 else if(err
== ERANGE
) break; /* End of tracefile */
822 err
= ltt_tracefile_read_update_event(tf
);
823 if(err
) goto update_error
;
825 /* We are on a facility load/or facility unload/ or heartbeat event */
827 * * facility 0 is hardcoded : this is the core facility. It will be shown
828 * in the facility array though, and is shown as "loaded builtin" in the
830 * It contains event :
832 * 1 : facility unload
833 * 2 : state dump facility load
836 if(tf
->event
.facility_id
!= LTT_FACILITY_CORE
) {
837 /* Should only contain core facility */
838 g_warning("Error in processing facility file %s, "
839 "should not contain facility id %u.", g_quark_to_string(tf
->name
),
840 tf
->event
.facility_id
);
845 struct LttFacilityLoad
*fac_load_data
;
846 struct LttStateDumpFacilityLoad
*fac_state_dump_load_data
;
850 switch((enum ltt_core_events
)tf
->event
.event_id
) {
851 case LTT_EVENT_FACILITY_LOAD
:
852 fac_name
= (char*)(tf
->event
.data
);
853 g_debug("Doing LTT_EVENT_FACILITY_LOAD of facility %s",
856 (struct LttFacilityLoad
*)
857 (tf
->event
.data
+ strlen(fac_name
) + 1);
858 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
859 ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
));
860 g_assert(fac
->exists
== 0);
861 fac
->name
= g_quark_from_string(fac_name
);
862 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
863 &fac_load_data
->checksum
);
864 fac
->id
= ltt_get_uint32(LTT_GET_BO(tf
), &fac_load_data
->id
);
865 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
866 &fac_load_data
->pointer_size
);
867 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
868 &fac_load_data
->long_size
);
869 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
870 &fac_load_data
->size_t_size
);
871 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
872 &fac_load_data
->alignment
);
874 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
875 continue; /* error opening description */
877 fac
->trace
= tf
->trace
;
879 /* Preset the field offsets */
880 for(i
=0; i
<fac
->events
->len
; i
++){
881 et
= &g_array_index(fac
->events
, LttEventType
, i
);
882 set_fields_offsets(tf
, et
);
887 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
889 if(fac_ids
== NULL
) {
890 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
891 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
893 fac_ids
, ltt_fac_ids_destroy
);
895 g_array_append_val(fac_ids
, fac
->id
);
898 case LTT_EVENT_FACILITY_UNLOAD
:
899 g_debug("Doing LTT_EVENT_FACILITY_UNLOAD");
900 /* We don't care about unload : facilities ID are valid for the whole
901 * trace. They simply won't be used after the unload. */
903 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
904 fac_name
= (char*)(tf
->event
.data
);
905 g_debug("Doing LTT_EVENT_STATE_DUMP_FACILITY_LOAD of facility %s",
907 fac_state_dump_load_data
=
908 (struct LttStateDumpFacilityLoad
*)
909 (tf
->event
.data
+ strlen(fac_name
) + 1);
910 fac
= &g_array_index (tf
->trace
->facilities_by_num
, LttFacility
,
911 ltt_get_uint32(LTT_GET_BO(tf
), &fac_state_dump_load_data
->id
));
912 g_assert(fac
->exists
== 0);
913 fac
->name
= g_quark_from_string(fac_name
);
914 fac
->checksum
= ltt_get_uint32(LTT_GET_BO(tf
),
915 &fac_state_dump_load_data
->checksum
);
916 fac
->id
= fac_state_dump_load_data
->id
;
917 fac
->pointer_size
= ltt_get_uint32(LTT_GET_BO(tf
),
918 &fac_state_dump_load_data
->pointer_size
);
919 fac
->long_size
= ltt_get_uint32(LTT_GET_BO(tf
),
920 &fac_state_dump_load_data
->long_size
);
921 fac
->size_t_size
= ltt_get_uint32(LTT_GET_BO(tf
),
922 &fac_state_dump_load_data
->size_t_size
);
923 fac
->alignment
= ltt_get_uint32(LTT_GET_BO(tf
),
924 &fac_state_dump_load_data
->alignment
);
925 if(ltt_get_facility_description(fac
, tf
->trace
, tf
))
926 continue; /* error opening description */
928 fac
->trace
= tf
->trace
;
930 /* Preset the field offsets */
931 for(i
=0; i
<fac
->events
->len
; i
++){
932 et
= &g_array_index(fac
->events
, LttEventType
, i
);
933 set_fields_offsets(tf
, et
);
938 fac_ids
= g_datalist_id_get_data(&tf
->trace
->facilities_by_name
,
940 if(fac_ids
== NULL
) {
941 fac_ids
= g_array_sized_new (FALSE
, TRUE
, sizeof(guint
), 1);
942 g_datalist_id_set_data_full(&tf
->trace
->facilities_by_name
,
944 fac_ids
, ltt_fac_ids_destroy
);
946 g_array_append_val(fac_ids
, fac
->id
);
949 case LTT_EVENT_HEARTBEAT
:
952 g_warning("Error in processing facility file %s, "
953 "unknown event id %hhu in core facility.",
954 g_quark_to_string(tf
->name
),
968 g_warning("An error occured in facility tracefile parsing");
973 LttTrace
*ltt_trace_open(const gchar
*pathname
)
975 gchar abs_path
[PATH_MAX
];
980 struct ltt_block_start_header
*header
;
982 struct dirent
*entry
;
983 guint control_found
= 0;
984 guint eventdefs_found
= 0;
985 struct stat stat_buf
;
986 gchar path
[PATH_MAX
];
988 t
= g_new(LttTrace
, 1);
989 if(!t
) goto alloc_error
;
991 get_absolute_pathname(pathname
, abs_path
);
992 t
->pathname
= g_quark_from_string(abs_path
);
994 g_datalist_init(&t
->tracefiles
);
996 /* Test to see if it looks like a trace */
997 dir
= opendir(abs_path
);
1002 while((entry
= readdir(dir
)) != NULL
) {
1003 strcpy(path
, abs_path
);
1005 strcat(path
, entry
->d_name
);
1006 ret
= stat(path
, &stat_buf
);
1011 if(S_ISDIR(stat_buf
.st_mode
)) {
1012 if(strcmp(entry
->d_name
, "control") == 0) {
1015 if(strcmp(entry
->d_name
, "eventdefs") == 0) {
1016 eventdefs_found
= 1;
1022 if(!control_found
|| !eventdefs_found
) goto find_error
;
1024 /* Open all the tracefiles */
1025 if(open_tracefiles(t
, abs_path
, "")) {
1026 g_warning("Error opening tracefile %s", abs_path
);
1030 /* Prepare the facilities containers : array and mapping */
1031 /* Array is zeroed : the "exists" field is set to false by default */
1032 t
->facilities_by_num
= g_array_sized_new (FALSE
,
1033 TRUE
, sizeof(LttFacility
),
1035 t
->facilities_by_num
= g_array_set_size(t
->facilities_by_num
, NUM_FACILITIES
);
1037 g_datalist_init(&t
->facilities_by_name
);
1039 /* Parse each trace control/facilitiesN files : get runtime fac. info */
1040 group
= g_datalist_id_get_data(&t
->tracefiles
, LTT_TRACEFILE_NAME_FACILITIES
);
1042 g_error("Trace %s has no facility tracefile", abs_path
);
1044 goto facilities_error
;
1047 /* Get the trace information for the control/facility 0 tracefile */
1048 g_assert(group
->len
> 0);
1049 tf
= &g_array_index (group
, LttTracefile
, 0);
1050 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1051 t
->arch_type
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_type
);
1052 t
->arch_variant
= ltt_get_uint32(LTT_GET_BO(tf
), &header
->trace
.arch_variant
);
1053 t
->arch_size
= header
->trace
.arch_size
;
1054 t
->ltt_major_version
= header
->trace
.major_version
;
1055 t
->ltt_minor_version
= header
->trace
.minor_version
;
1056 t
->flight_recorder
= header
->trace
.flight_recorder
;
1057 t
->has_heartbeat
= header
->trace
.has_heartbeat
;
1058 t
->has_alignment
= header
->trace
.has_alignment
;
1059 t
->has_tsc
= header
->trace
.has_tsc
;
1061 t
->num_cpu
= group
->len
;
1063 for(i
=0; i
<group
->len
; i
++) {
1064 tf
= &g_array_index (group
, LttTracefile
, i
);
1065 if(ltt_process_facility_tracefile(tf
))
1066 goto facilities_error
;
1071 /* Error handling */
1073 g_datalist_clear(&t
->facilities_by_name
);
1074 g_array_free(t
->facilities_by_num
, TRUE
);
1076 g_datalist_clear(&t
->tracefiles
);
1084 GQuark
ltt_trace_name(const LttTrace
*t
)
1090 /******************************************************************************
1091 * When we copy a trace, we want all the opening actions to happen again :
1092 * the trace will be reopened and totally independant from the original.
1093 * That's why we call ltt_trace_open.
1094 *****************************************************************************/
1095 LttTrace
*ltt_trace_copy(LttTrace
*self
)
1097 return ltt_trace_open(g_quark_to_string(self
->pathname
));
1100 void ltt_trace_close(LttTrace
*t
)
1105 for(i
=0; i
<t
->facilities_by_num
->len
; i
++) {
1106 fac
= &g_array_index (t
->facilities_by_num
, LttFacility
, i
);
1108 ltt_facility_close(fac
);
1111 g_datalist_clear(&t
->facilities_by_name
);
1112 g_array_free(t
->facilities_by_num
, TRUE
);
1113 g_datalist_clear(&t
->tracefiles
);
1118 /*****************************************************************************
1119 *Get the system description of the trace
1120 ****************************************************************************/
1122 LttFacility
*ltt_trace_facility_by_id(LttTrace
*t
, guint8 id
)
1124 g_assert(id
< t
->facilities_by_num
->len
);
1125 return &g_array_index(t
->facilities_by_num
, LttFacility
, id
);
1128 /* ltt_trace_facility_get_by_name
1130 * Returns the GArray of facility indexes. All the fac_ids that matches the
1131 * requested facility name.
1133 * If name is not found, returns NULL.
1135 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
)
1137 return g_datalist_id_get_data(&t
->facilities_by_name
, name
);
1140 /*****************************************************************************
1141 * Functions to discover all the event types in the trace
1142 ****************************************************************************/
1145 unsigned ltt_trace_eventtype_number(LttTrace
*t
)
1149 unsigned int num
= t
->facility_number
;
1153 f
= (LttFacility
*)g_ptr_array_index(t
->facilities
, i
);
1154 count
+= f
->event_number
;
1161 //use an iteration on all the trace facilities, and inside iteration on all the
1162 //event types in each facilities instead.
1163 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned evId
)
1165 LttEventType
*event_type
;
1168 f
= ltt_trace_facility_by_id(t
,evId
);
1170 if(unlikely(!f
)) event_type
= NULL
;
1171 else event_type
= f
->events
[evId
- f
->base_id
];
1178 /*****************************************************************************
1179 * ltt_trace_find_tracefile
1181 * Find a tracefile by name and index in the group.
1183 * Returns a pointer to the tracefiles, else NULL.
1184 ****************************************************************************/
1186 LttTracefile
*ltt_trace_find_tracefile(LttTrace
*t
, const gchar
*name
)
1191 /*****************************************************************************
1192 * Get the start time and end time of the trace
1193 ****************************************************************************/
1195 static void ltt_tracefile_time_span_get(LttTracefile
*tf
,
1196 LttTime
*start
, LttTime
*end
)
1200 err
= map_block(tf
, 0);
1202 g_error("Can not map block");
1203 *start
= ltt_time_infinite
;
1205 *start
= tf
->buffer
.begin
.timestamp
;
1207 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1209 g_error("Can not map block");
1210 *end
= ltt_time_zero
;
1212 *end
= tf
->buffer
.end
.timestamp
;
1215 struct tracefile_time_span_get_args
{
1221 static void group_time_span_get(GQuark name
, gpointer data
, gpointer user_data
)
1223 struct tracefile_time_span_get_args
*args
=
1224 (struct tracefile_time_span_get_args
*)user_data
;
1226 GArray
*group
= (GArray
*)data
;
1232 for(i
=0; i
<group
->len
; i
++) {
1233 tf
= &g_array_index (group
, LttTracefile
, i
);
1234 if(tf
->cpu_online
) {
1235 ltt_tracefile_time_span_get(tf
, &tmp_start
, &tmp_end
);
1236 if(ltt_time_compare(*args
->start
, tmp_start
)>0) *args
->start
= tmp_start
;
1237 if(ltt_time_compare(*args
->end
, tmp_end
)<0) *args
->end
= tmp_end
;
1242 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
)
1244 LttTime min_start
= ltt_time_infinite
;
1245 LttTime max_end
= ltt_time_zero
;
1246 struct tracefile_time_span_get_args args
= { t
, &min_start
, &max_end
};
1248 g_datalist_foreach(&t
->tracefiles
, &group_time_span_get
, &args
);
1250 if(start
!= NULL
) *start
= min_start
;
1251 if(end
!= NULL
) *end
= max_end
;
1256 /*****************************************************************************
1257 *Get the name of a tracefile
1258 ****************************************************************************/
1260 GQuark
ltt_tracefile_name(LttTracefile
*tf
)
1266 guint
ltt_tracefile_num(LttTracefile
*tf
)
1271 /*****************************************************************************
1272 * Get the number of blocks in the tracefile
1273 ****************************************************************************/
1275 guint
ltt_tracefile_block_number(LttTracefile
*tf
)
1277 return tf
->num_blocks
;
1281 /* Seek to the first event in a tracefile that has a time equal or greater than
1282 * the time passed in parameter.
1284 * If the time parameter is outside the tracefile time span, seek to the first
1285 * event or if after, return ERANGE.
1287 * If the time parameter is before the first event, we have to seek specially to
1290 * If the time is after the end of the trace, return ERANGE.
1292 * Do a binary search to find the right block, then a sequential search in the
1293 * block to find the event.
1295 * In the special case where the time requested fits inside a block that has no
1296 * event corresponding to the requested time, the first event of the next block
1299 * IMPORTANT NOTE : // FIXME everywhere...
1301 * You MUST NOT do a ltt_tracefile_read right after a ltt_tracefile_seek_time :
1302 * you will jump over an event if you do.
1304 * Return value : 0 : no error, the tf->event can be used
1305 * ERANGE : time if after the last event of the trace
1306 * otherwise : this is an error.
1310 int ltt_tracefile_seek_time(LttTracefile
*tf
, LttTime time
)
1314 unsigned int block_num
, high
, low
;
1316 /* seek at the beginning of trace */
1317 err
= map_block(tf
, 0); /* First block */
1319 g_error("Can not map block");
1323 /* If the time is lower or equal the beginning of the trace,
1324 * go to the first event. */
1325 if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) <= 0) {
1326 ret
= ltt_tracefile_read(tf
);
1327 if(ret
== ERANGE
) goto range
;
1328 else if (ret
) goto fail
;
1329 goto found
; /* There is either no event in the trace or the event points
1330 to the first event in the trace */
1333 err
= map_block(tf
, tf
->num_blocks
- 1); /* Last block */
1335 g_error("Can not map block");
1339 /* If the time is after the end of the trace, return ERANGE. */
1340 if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1344 /* Binary search the block */
1345 high
= tf
->num_blocks
- 1;
1349 block_num
= ((high
-low
) / 2) + low
;
1351 err
= map_block(tf
, block_num
);
1353 g_error("Can not map block");
1357 /* We cannot divide anymore : this is what would happen if the time
1358 * requested was exactly between two consecutive buffers'end and start
1359 * timestamps. This is also what would happend if we didn't deal with out
1360 * of span cases prior in this function. */
1361 /* The event is right in the buffer!
1362 * (or in the next buffer first event) */
1364 ret
= ltt_tracefile_read(tf
);
1365 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1366 else if(ret
) goto fail
;
1368 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1372 } else if(ltt_time_compare(time
, tf
->buffer
.begin
.timestamp
) < 0) {
1373 /* go to lower part */
1375 } else if(ltt_time_compare(time
, tf
->buffer
.end
.timestamp
) > 0) {
1376 /* go to higher part */
1378 } else {/* The event is right in the buffer!
1379 (or in the next buffer first event) */
1381 ret
= ltt_tracefile_read(tf
);
1382 if(ret
== ERANGE
) goto range
; /* ERANGE or EPERM */
1383 else if(ret
) goto fail
;
1385 if(ltt_time_compare(time
, tf
->event
.event_time
) >= 0)
1397 /* Error handling */
1399 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1400 g_quark_to_string(tf
->name
));
1405 int ltt_tracefile_seek_position(LttTracefile
*tf
, const LttEventPosition
*ep
) {
1409 if(ep
->tracefile
!= tf
) {
1413 err
= map_block(tf
, ep
->block
);
1415 g_error("Can not map block");
1419 tf
->event
.offset
= ep
->offset
;
1421 err
= ltt_tracefile_read_update_event(tf
);
1423 err
= ltt_tracefile_read_op(tf
);
1429 g_error("ltt_tracefile_seek_time failed on tracefile %s",
1430 g_quark_to_string(tf
->name
));
1434 /* Calculate the real event time based on the buffer boundaries */
1435 LttTime
ltt_interpolate_time(LttTracefile
*tf
, LttEvent
*event
)
1439 g_assert(tf
->trace
->has_tsc
);
1441 time
= ltt_time_from_uint64(
1442 (guint64
)(tf
->buffer
.tsc
- tf
->buffer
.begin
.cycle_count
) *
1443 tf
->buffer
.nsecs_per_cycle
);
1444 time
= ltt_time_add(tf
->buffer
.begin
.timestamp
, time
);
1450 /* Get the current event of the tracefile : valid until the next read */
1451 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
)
1458 /*****************************************************************************
1460 * ltt_tracefile_read : Read the next event in the tracefile
1465 * Returns 0 if an event can be used in tf->event.
1466 * Returns ERANGE on end of trace. The event in tf->event still can be used
1467 * (if the last block was not empty).
1468 * Returns EPERM on error.
1470 * This function does make the tracefile event structure point to the event
1471 * currently pointed to by the tf->event.
1473 * Note : you must call a ltt_tracefile_seek to the beginning of the trace to
1474 * reinitialize it after an error if you want results to be coherent.
1475 * It would be the case if a end of trace last buffer has no event : the end
1476 * of trace wouldn't be returned, but an error.
1477 * We make the assumption there is at least one event per buffer.
1478 ****************************************************************************/
1480 int ltt_tracefile_read(LttTracefile
*tf
)
1484 err
= ltt_tracefile_read_seek(tf
);
1486 err
= ltt_tracefile_read_update_event(tf
);
1488 err
= ltt_tracefile_read_op(tf
);
1494 int ltt_tracefile_read_seek(LttTracefile
*tf
)
1498 /* Get next buffer until we finally have an event, or end of trace */
1500 err
= ltt_seek_next_event(tf
);
1501 if(unlikely(err
== ENOPROTOOPT
)) {
1505 /* Are we at the end of the buffer ? */
1507 if(unlikely(tf
->buffer
.index
== tf
->num_blocks
-1)){ /* end of trace ? */
1510 /* get next block */
1511 err
= map_block(tf
, tf
->buffer
.index
+ 1);
1513 g_error("Can not map block");
1517 } else break; /* We found an event ! */
1524 /* do specific operation on events */
1525 int ltt_tracefile_read_op(LttTracefile
*tf
)
1531 /* do event specific operation */
1533 /* do something if its an heartbeat event : increment the heartbeat count */
1534 //if(event->facility_id == LTT_FACILITY_CORE)
1535 // if(event->event_id == LTT_EVENT_HEARTBEAT)
1536 // tf->cur_heart_beat_number++;
1542 /* same as ltt_tracefile_read, but does not seek to the next event nor call
1543 * event specific operation. */
1544 int ltt_tracefile_read_update_event(LttTracefile
*tf
)
1550 pos
= tf
->buffer
.head
+ event
->offset
;
1552 /* Read event header */
1556 if(tf
->trace
->has_tsc
) {
1557 if(tf
->trace
->has_heartbeat
) {
1558 event
->time
.timestamp
= ltt_get_uint32(LTT_GET_BO(tf
),
1560 /* 32 bits -> 64 bits tsc */
1561 /* note : still works for seek and non seek cases. */
1562 if(event
->time
.timestamp
< (0xFFFFFFFFULL
&tf
->buffer
.tsc
)) {
1563 tf
->buffer
.tsc
= ((tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1565 | (guint64
)event
->time
.timestamp
;
1566 event
->tsc
= tf
->buffer
.tsc
;
1569 tf
->buffer
.tsc
= (tf
->buffer
.tsc
&0xFFFFFFFF00000000ULL
)
1570 | (guint64
)event
->time
.timestamp
;
1571 event
->tsc
= tf
->buffer
.tsc
;
1573 pos
+= sizeof(guint32
);
1575 event
->tsc
= ltt_get_uint64(LTT_GET_BO(tf
), pos
);
1576 tf
->buffer
.tsc
= event
->tsc
;
1577 pos
+= sizeof(guint64
);
1580 event
->event_time
= ltt_interpolate_time(tf
, event
);
1582 event
->time
.delta
.tv_sec
= 0;
1583 event
->time
.delta
.tv_nsec
= ltt_get_uint32(LTT_GET_BO(tf
),
1584 pos
) * NSEC_PER_USEC
;
1586 event
->tsc
= tf
->buffer
.tsc
;
1588 event
->event_time
= ltt_time_add(tf
->buffer
.begin
.timestamp
,
1590 pos
+= sizeof(guint32
);
1593 event
->facility_id
= *(guint8
*)pos
;
1594 pos
+= sizeof(guint8
);
1596 event
->event_id
= *(guint8
*)pos
;
1597 pos
+= sizeof(guint8
);
1599 event
->event_size
= ltt_get_uint16(LTT_GET_BO(tf
), pos
);
1600 pos
+= sizeof(guint16
);
1604 /* get the data size and update the event fields with the current
1606 ltt_update_event_size(tf
);
1612 /****************************************************************************
1614 * map_block : map a block from the file
1616 * lttdes : ltt trace file
1617 * whichBlock : the block which will be read
1620 * EINVAL : lseek fail
1621 * EIO : can not read from the file
1622 ****************************************************************************/
1624 static gint
map_block(LttTracefile
* tf
, guint block_num
)
1626 int page_size
= getpagesize();
1627 struct ltt_block_start_header
*header
;
1629 g_assert(block_num
< tf
->num_blocks
);
1631 if(tf
->buffer
.head
!= NULL
) {
1632 if(munmap(tf
->buffer
.head
, PAGE_ALIGN(tf
->buf_size
))) {
1633 g_warning("unmap size : %u\n",
1634 PAGE_ALIGN(tf
->buf_size
));
1635 perror("munmap error");
1641 /* Multiple of pages aligned head */
1642 tf
->buffer
.head
= mmap(0,
1643 PAGE_ALIGN(tf
->buf_size
),
1644 PROT_READ
, MAP_PRIVATE
, tf
->fd
,
1645 PAGE_ALIGN((off_t
)tf
->buf_size
* (off_t
)block_num
));
1647 if(tf
->buffer
.head
== MAP_FAILED
) {
1648 perror("Error in allocating memory for buffer of tracefile");
1652 g_assert( ( (guint
)tf
->buffer
.head
&(8-1) ) == 0); // make sure it's aligned.
1655 tf
->buffer
.index
= block_num
;
1657 header
= (struct ltt_block_start_header
*)tf
->buffer
.head
;
1659 tf
->buffer
.begin
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1660 &header
->begin
.timestamp
);
1661 tf
->buffer
.begin
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1662 g_debug("block %u begin : %lu.%lu", block_num
,
1663 tf
->buffer
.begin
.timestamp
.tv_sec
, tf
->buffer
.begin
.timestamp
.tv_nsec
);
1664 tf
->buffer
.begin
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1665 &header
->begin
.cycle_count
);
1666 tf
->buffer
.end
.timestamp
= ltt_get_time(LTT_GET_BO(tf
),
1667 &header
->end
.timestamp
);
1668 tf
->buffer
.end
.timestamp
.tv_nsec
*= NSEC_PER_USEC
;
1669 g_debug("block %u end : %lu.%lu", block_num
,
1670 tf
->buffer
.end
.timestamp
.tv_sec
, tf
->buffer
.end
.timestamp
.tv_nsec
);
1671 tf
->buffer
.end
.cycle_count
= ltt_get_uint64(LTT_GET_BO(tf
),
1672 &header
->end
.cycle_count
);
1673 tf
->buffer
.lost_size
= ltt_get_uint32(LTT_GET_BO(tf
),
1674 &header
->lost_size
);
1676 tf
->buffer
.tsc
= tf
->buffer
.begin
.cycle_count
;
1677 tf
->event
.tsc
= tf
->buffer
.tsc
;
1680 * eventually support variable buffer size : will need a partial pre-read of
1681 * the headers to create an index when we open the trace... eventually. */
1682 g_assert(tf
->buf_size
== ltt_get_uint32(LTT_GET_BO(tf
),
1683 &header
->buf_size
));
1685 /* Now that the buffer is mapped, calculate the time interpolation for the
1688 tf
->buffer
.nsecs_per_cycle
= calc_nsecs_per_cycle(tf
);
1690 /* Make the current event point to the beginning of the buffer :
1691 * it means that the event read must get the first event. */
1692 tf
->event
.tracefile
= tf
;
1693 tf
->event
.block
= block_num
;
1694 tf
->event
.offset
= 0;
1703 /* It will update the fields offsets too */
1704 void ltt_update_event_size(LttTracefile
*tf
)
1708 /* Specific handling of core events : necessary to read the facility control
1710 LttFacility
*f
= ltt_trace_get_facility_by_num(tf
->trace
,
1711 tf
->event
.facility_id
);
1713 if(likely(tf
->event
.facility_id
== LTT_FACILITY_CORE
)) {
1714 switch((enum ltt_core_events
)tf
->event
.event_id
) {
1715 case LTT_EVENT_FACILITY_LOAD
:
1716 size
= strlen((char*)tf
->event
.data
) + 1;
1717 g_debug("Update Event facility load of facility %s", (char*)tf
->event
.data
);
1718 size
+= sizeof(struct LttFacilityLoad
);
1720 case LTT_EVENT_FACILITY_UNLOAD
:
1721 g_debug("Update Event facility unload");
1722 size
= sizeof(struct LttFacilityUnload
);
1724 case LTT_EVENT_STATE_DUMP_FACILITY_LOAD
:
1725 size
= strlen((char*)tf
->event
.data
) + 1;
1726 g_debug("Update Event facility load state dump of facility %s",
1727 (char*)tf
->event
.data
);
1728 size
+= sizeof(struct LttStateDumpFacilityLoad
);
1730 case LTT_EVENT_HEARTBEAT
:
1731 g_debug("Update Event heartbeat");
1732 size
= sizeof(TimeHeartbeat
);
1735 g_warning("Error in getting event size : tracefile %s, "
1736 "unknown event id %hhu in core facility.",
1737 g_quark_to_string(tf
->name
),
1738 tf
->event
.event_id
);
1739 goto event_id_error
;
1744 g_error("Unknown facility %hhu (0x%hhx) in tracefile %s",
1745 tf
->event
.facility_id
,
1746 tf
->event
.facility_id
,
1747 g_quark_to_string(tf
->name
));
1748 goto facility_error
;
1751 LttEventType
*event_type
=
1752 ltt_facility_eventtype_get(f
, tf
->event
.event_id
);
1755 g_error("Unknown event id %hhu in facility %s in tracefile %s",
1757 g_quark_to_string(f
->name
),
1758 g_quark_to_string(tf
->name
));
1759 goto event_type_error
;
1762 if(event_type
->root_field
)
1763 size
= get_field_type_size(tf
, event_type
,
1764 0, 0, event_type
->root_field
, tf
->event
.data
);
1768 g_debug("Event root field : f.e %hhu.%hhu size %zd",
1769 tf
->event
.facility_id
,
1770 tf
->event
.event_id
, size
);
1773 tf
->event
.data_size
= size
;
1775 /* Check consistency between kernel and LTTV structure sizes */
1776 g_assert(tf
->event
.data_size
== tf
->event
.event_size
);
1783 tf
->event
.data_size
= 0;
1787 /* Take the tf current event offset and use the event facility id and event id
1788 * to figure out where is the next event offset.
1790 * This is an internal function not aiming at being used elsewhere : it will
1791 * not jump over the current block limits. Please consider using
1792 * ltt_tracefile_read to do this.
1794 * Returns 0 on success
1795 * ERANGE if we are at the end of the buffer.
1796 * ENOPROTOOPT if an error occured when getting the current event size.
1798 static int ltt_seek_next_event(LttTracefile
*tf
)
1803 /* seek over the buffer header if we are at the buffer start */
1804 if(tf
->event
.offset
== 0) {
1805 tf
->event
.offset
+= sizeof(struct ltt_block_start_header
);
1807 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1814 pos
= tf
->event
.data
;
1816 if(tf
->event
.data_size
< 0) goto error
;
1818 pos
+= (size_t)tf
->event
.data_size
;
1820 tf
->event
.offset
= pos
- tf
->buffer
.head
;
1822 if(tf
->event
.offset
== tf
->buf_size
- tf
->buffer
.lost_size
) {
1831 g_error("Error in ltt_seek_next_event for tracefile %s",
1832 g_quark_to_string(tf
->name
));
1837 /*****************************************************************************
1839 * calc_nsecs_per_cycle : calculate nsecs per cycle for current block
1842 ****************************************************************************/
1844 static double calc_nsecs_per_cycle(LttTracefile
* tf
)
1846 LttTime lBufTotalTime
; /* Total time for this buffer */
1847 double lBufTotalNSec
; /* Total time for this buffer in nsecs */
1848 LttCycleCount lBufTotalCycle
;/* Total cycles for this buffer */
1850 /* Calculate the total time for this buffer */
1851 lBufTotalTime
= ltt_time_sub(tf
->buffer
.end
.timestamp
,
1852 tf
->buffer
.begin
.timestamp
);
1854 /* Calculate the total cycles for this bufffer */
1855 lBufTotalCycle
= tf
->buffer
.end
.cycle_count
;
1856 lBufTotalCycle
-= tf
->buffer
.begin
.cycle_count
;
1858 /* Convert the total time to double */
1859 lBufTotalNSec
= ltt_time_to_double(lBufTotalTime
);
1861 return lBufTotalNSec
/ (double)lBufTotalCycle
;
1865 void setFieldsOffset(LttTracefile
*tf
, LttEventType
*evT
,void *evD
)
1867 LttField
* rootFld
= evT
->root_field
;
1868 // rootFld->base_address = evD;
1871 rootFld
->field_size
= getFieldtypeSize(tf
, evT
->facility
,
1872 evT
, 0,0,rootFld
, evD
);
1876 /*****************************************************************************
1878 * set_fields_offsets : set the precomputable offset of the fields
1880 * tracefile : opened trace file
1881 * event_type : the event type
1882 ****************************************************************************/
1884 void set_fields_offsets(LttTracefile
*tf
, LttEventType
*event_type
)
1886 LttField
*field
= event_type
->root_field
;
1887 enum field_status fixed_root
= FIELD_FIXED
, fixed_parent
= FIELD_FIXED
;
1890 preset_field_type_size(tf
, event_type
, 0, 0,
1891 &fixed_root
, &fixed_parent
,
1897 /*****************************************************************************
1899 * preset_field_type_size : set the fixed sizes of the field type
1902 * event_type : event type
1903 * offset_root : offset from the root
1904 * offset_parent : offset from the parent
1905 * fixed_root : Do we know a fixed offset to the root ?
1906 * fixed_parent : Do we know a fixed offset to the parent ?
1908 ****************************************************************************/
1909 void preset_field_type_size(LttTracefile
*tf
, LttEventType
*event_type
,
1910 off_t offset_root
, off_t offset_parent
,
1911 enum field_status
*fixed_root
, enum field_status
*fixed_parent
,
1914 enum field_status local_fixed_root
, local_fixed_parent
;
1918 g_assert(field
->fixed_root
== FIELD_UNKNOWN
);
1919 g_assert(field
->fixed_parent
== FIELD_UNKNOWN
);
1920 g_assert(field
->fixed_size
== FIELD_UNKNOWN
);
1922 type
= field
->field_type
;
1924 field
->fixed_root
= *fixed_root
;
1925 if(field
->fixed_root
== FIELD_FIXED
)
1926 field
->offset_root
= offset_root
;
1928 field
->offset_root
= 0;
1930 field
->fixed_parent
= *fixed_parent
;
1931 if(field
->fixed_parent
== FIELD_FIXED
)
1932 field
->offset_parent
= offset_parent
;
1934 field
->offset_parent
= 0;
1936 size_t current_root_offset
;
1937 size_t current_offset
;
1938 enum field_status current_child_status
, final_child_status
;
1941 switch(type
->type_class
) {
1946 field
->field_size
= ltt_type_size(tf
->trace
, type
);
1947 field
->fixed_size
= FIELD_FIXED
;
1950 field
->field_size
= (off_t
)event_type
->facility
->pointer_size
;
1951 field
->fixed_size
= FIELD_FIXED
;
1955 field
->field_size
= (off_t
)event_type
->facility
->long_size
;
1956 field
->fixed_size
= FIELD_FIXED
;
1961 field
->field_size
= (off_t
)event_type
->facility
->size_t_size
;
1962 field
->fixed_size
= FIELD_FIXED
;
1965 local_fixed_root
= FIELD_VARIABLE
;
1966 local_fixed_parent
= FIELD_VARIABLE
;
1967 preset_field_type_size(tf
, event_type
,
1969 &local_fixed_root
, &local_fixed_parent
,
1971 field
->fixed_size
= FIELD_VARIABLE
;
1972 field
->field_size
= 0;
1973 *fixed_root
= FIELD_VARIABLE
;
1974 *fixed_parent
= FIELD_VARIABLE
;
1977 field
->fixed_size
= FIELD_VARIABLE
;
1978 field
->field_size
= 0;
1979 *fixed_root
= FIELD_VARIABLE
;
1980 *fixed_parent
= FIELD_VARIABLE
;
1983 local_fixed_root
= FIELD_VARIABLE
;
1984 local_fixed_parent
= FIELD_VARIABLE
;
1985 preset_field_type_size(tf
, event_type
,
1987 &local_fixed_root
, &local_fixed_parent
,
1989 field
->fixed_size
= field
->child
[0]->fixed_size
;
1990 if(field
->fixed_size
== FIELD_FIXED
) {
1991 field
->field_size
= type
->element_number
* field
->child
[0]->field_size
;
1993 field
->field_size
= 0;
1994 *fixed_root
= FIELD_VARIABLE
;
1995 *fixed_parent
= FIELD_VARIABLE
;
1999 current_root_offset
= field
->offset_root
;
2001 current_child_status
= FIELD_FIXED
;
2002 for(i
=0;i
<type
->element_number
;i
++) {
2003 preset_field_type_size(tf
, event_type
,
2004 current_root_offset
, current_offset
,
2005 fixed_root
, ¤t_child_status
,
2007 if(current_child_status
== FIELD_FIXED
) {
2008 current_root_offset
+= field
->child
[i
]->field_size
;
2009 current_offset
+= field
->child
[i
]->field_size
;
2011 current_root_offset
= 0;
2015 if(current_child_status
!= FIELD_FIXED
) {
2016 *fixed_parent
= current_child_status
;
2017 field
->field_size
= 0;
2018 field
->fixed_size
= current_child_status
;
2020 field
->field_size
= current_offset
;
2021 field
->fixed_size
= FIELD_FIXED
;
2025 current_root_offset
= field
->offset_root
;
2028 final_child_status
= FIELD_FIXED
;
2029 for(i
=0;i
<type
->element_number
;i
++) {
2030 enum field_status current_root_child_status
= FIELD_FIXED
;
2031 enum field_status current_child_status
= FIELD_FIXED
;
2032 preset_field_type_size(tf
, event_type
,
2033 current_root_offset
, current_offset
,
2034 ¤t_root_child_status
, ¤t_child_status
,
2036 if(current_child_status
!= FIELD_FIXED
)
2037 final_child_status
= current_child_status
;
2039 max_size
= max(max_size
, field
->child
[i
]->field_size
);
2041 if(final_child_status
!= FIELD_FIXED
) {
2042 *fixed_root
= final_child_status
;
2043 *fixed_parent
= final_child_status
;
2044 field
->field_size
= 0;
2045 field
->fixed_size
= current_child_status
;
2047 field
->field_size
= max_size
;
2048 field
->fixed_size
= FIELD_FIXED
;
2056 /*****************************************************************************
2058 * check_fields_compatibility : Check for compatibility between two fields :
2059 * do they use the same inner structure ?
2061 * event_type1 : event type
2062 * event_type2 : event type
2065 *Returns : 0 if identical
2067 ****************************************************************************/
2068 gint
check_fields_compatibility(LttEventType
*event_type1
,
2069 LttEventType
*event_type2
,
2070 LttField
*field1
, LttField
*field2
)
2072 guint different
= 0;
2077 if(field1
== NULL
) {
2078 if(field2
== NULL
) goto end
;
2083 } else if(field2
== NULL
) {
2088 g_assert(field1
->fixed_root
!= FIELD_UNKNOWN
);
2089 g_assert(field2
->fixed_root
!= FIELD_UNKNOWN
);
2090 g_assert(field1
->fixed_parent
!= FIELD_UNKNOWN
);
2091 g_assert(field2
->fixed_parent
!= FIELD_UNKNOWN
);
2092 g_assert(field1
->fixed_size
!= FIELD_UNKNOWN
);
2093 g_assert(field2
->fixed_size
!= FIELD_UNKNOWN
);
2095 type1
= field1
->field_type
;
2096 type2
= field2
->field_type
;
2098 if(type1
->type_class
!= type2
->type_class
) {
2102 if(type1
->element_name
!= type2
->element_name
) {
2107 switch(type1
->type_class
) {
2117 if(field1
->field_size
!= field2
->field_size
) {
2123 if(type1
->element_number
!= type2
->element_number
) {
2127 for(i
=0;i
<type1
->element_number
;i
++) {
2128 if(type1
->enum_strings
[i
] != type2
->enum_strings
[i
]) {
2135 /* Two elements : size and child */
2136 g_assert(type1
->element_number
!= type2
->element_number
);
2137 for(i
=0;i
<type1
->element_number
;i
++) {
2138 if(check_fields_compatibility(event_type1
, event_type2
,
2139 field1
->child
[0], field2
->child
[0])) {
2148 if(field1
->field_size
!= field2
->field_size
) {
2152 /* Two elements : size and child */
2153 g_assert(type1
->element_number
!= type2
->element_number
);
2154 for(i
=0;i
<type1
->element_number
;i
++) {
2155 if(check_fields_compatibility(event_type1
, event_type2
,
2156 field1
->child
[0], field2
->child
[0])) {
2164 if(type1
->element_number
!= type2
->element_number
) {
2168 for(i
=0;i
<type1
->element_number
;i
++) {
2169 if(check_fields_compatibility(event_type1
, event_type2
,
2170 field1
->child
[0], field2
->child
[0])) {
2185 /*****************************************************************************
2187 * getFieldtypeSize: get the size of the field type (primitive type)
2190 * offsetRoot : offset from the root
2191 * offsetParent : offset from the parrent
2193 * evD : event data, it may be NULL
2195 * int : size of the field
2196 ****************************************************************************/
2198 static inline gint
getFieldtypeSize(LttTracefile
*tf
,
2199 LttEventType
* evT
, gint offsetRoot
,
2200 gint offsetParent
, LttField
* fld
, void *evD
)
2202 gint size
, size1
, element_number
, i
, offset1
, offset2
;
2203 LttType
* type
= fld
->field_type
;
2205 /* This likely has been tested with gcov : half of them.. */
2206 if(unlikely(fld
->field_fixed
== 1)){
2208 if(unlikely(fld
== evT
->root_field
)) {
2209 size
= fld
->field_size
;
2210 goto end_getFieldtypeSize
;
2214 /* From gcov profiling : half string, half struct, can we gain something
2215 * from that ? (Mathieu) */
2216 switch(type
->type_class
) {
2218 element_number
= (int) type
->element_number
;
2219 if(fld
->field_fixed
== -1){
2220 size
= getFieldtypeSize(tf
, evT
, offsetRoot
,
2221 0,fld
->child
[0], NULL
);
2222 if(size
== 0){ //has string or sequence
2223 fld
->field_fixed
= 0;
2225 fld
->field_fixed
= 1;
2226 size
*= element_number
;
2228 }else if(fld
->field_fixed
== 0){// has string or sequence
2230 for(i
=0;i
<element_number
;i
++){
2231 size
+= getFieldtypeSize(tf
, evT
, offsetRoot
+size
,size
,
2232 fld
->child
[0], evD
+size
);
2234 }else size
= fld
->field_size
;
2236 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2237 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2243 size1
= (int) ltt_type_size(fac
, type
);
2244 if(fld
->field_fixed
== -1){
2245 fld
->sequ_number_size
= size1
;
2246 fld
->field_fixed
= 0;
2247 size
= getFieldtypeSize(evT
, offsetRoot
,
2248 0,fld
->child
[0], NULL
);
2249 fld
->element_size
= size
;
2251 element_number
= getIntNumber(tf
,size1
,evD
);
2252 type
->element_number
= element_number
;
2253 if(fld
->element_size
> 0){
2254 size
= element_number
* fld
->element_size
;
2255 }else{//sequence has string or sequence
2257 for(i
=0;i
<element_number
;i
++){
2258 size
+= getFieldtypeSize(tf
, evT
,
2259 offsetRoot
+size
+size1
,size
+size1
,
2260 fld
->child
[0], evD
+size
+size1
);
2266 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2267 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2274 if(fld
->field_fixed
== -1){
2275 fld
->field_fixed
= 0;
2277 /* Hope my implementation is faster than strlen (Mathieu) */
2278 char *ptr
=(char*)evD
;
2280 /* from gcov : many many strings are empty, make it the common case.*/
2281 while(unlikely(*ptr
!= '\0')) { size
++; ptr
++; }
2282 //size = ptr - (char*)evD + 1; //include end : '\0'
2284 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2285 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2290 element_number
= (int) type
->element_number
;
2292 /* tested with gcov */
2293 if(unlikely(fld
->field_fixed
== -1)){
2294 offset1
= offsetRoot
;
2296 for(i
=0;i
<element_number
;i
++){
2297 size1
=getFieldtypeSize(tf
, evT
,offset1
,offset2
,
2298 fld
->child
[i
], NULL
);
2299 if(likely(size1
> 0 && size
>= 0)){
2301 if(likely(offset1
>= 0)) offset1
+= size1
;
2309 if(unlikely(size
== -1)){
2310 fld
->field_fixed
= 0;
2312 }else fld
->field_fixed
= 1;
2313 }else if(likely(fld
->field_fixed
== 0)){
2314 offset1
= offsetRoot
;
2316 for(i
=0;unlikely(i
<element_number
);i
++){
2317 size
=getFieldtypeSize(tf
, evT
, offset1
, offset2
,
2318 fld
->child
[i
], evD
+offset2
);
2323 }else size
= fld
->field_size
;
2324 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2325 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2329 if(unlikely(fld
->field_fixed
== -1)){
2330 size
= (int) ltt_type_size(LTT_GET_BO(tf
), type
);
2331 fld
->field_fixed
= 1;
2332 }else size
= fld
->field_size
;
2334 fld
->fixed_root
= (offsetRoot
==-1) ? 0 : 1;
2335 fld
->fixed_parent
= (offsetParent
==-1) ? 0 : 1;
2340 fld
->offset_root
= offsetRoot
;
2341 fld
->offset_parent
= offsetParent
;
2342 fld
->field_size
= size
;
2344 end_getFieldtypeSize
:
2350 /*****************************************************************************
2352 * ltt_get_int : get an integer number
2354 * reverse_byte_order: must we reverse the byte order ?
2355 * size : the size of the integer
2356 * ptr : the data pointer
2358 * gint64 : a 64 bits integer
2359 ****************************************************************************/
2361 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
)
2366 case 1: val
= *((gint8
*)data
); break;
2367 case 2: val
= ltt_get_int16(reverse_byte_order
, data
); break;
2368 case 4: val
= ltt_get_int32(reverse_byte_order
, data
); break;
2369 case 8: val
= ltt_get_int64(reverse_byte_order
, data
); break;
2370 default: val
= ltt_get_int64(reverse_byte_order
, data
);
2371 g_critical("get_int : integer size %d unknown", size
);
2378 /*****************************************************************************
2380 * ltt_get_uint : get an unsigned integer number
2382 * reverse_byte_order: must we reverse the byte order ?
2383 * size : the size of the integer
2384 * ptr : the data pointer
2386 * guint64 : a 64 bits unsigned integer
2387 ****************************************************************************/
2389 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
)
2394 case 1: val
= *((gint8
*)data
); break;
2395 case 2: val
= ltt_get_uint16(reverse_byte_order
, data
); break;
2396 case 4: val
= ltt_get_uint32(reverse_byte_order
, data
); break;
2397 case 8: val
= ltt_get_uint64(reverse_byte_order
, data
); break;
2398 default: val
= ltt_get_uint64(reverse_byte_order
, data
);
2399 g_critical("get_uint : unsigned integer size %d unknown",
2408 /* get the node name of the system */
2410 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
)
2412 return s
->node_name
;
2416 /* get the domain name of the system */
2418 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
)
2420 return s
->domain_name
;
2424 /* get the description of the system */
2426 char * ltt_trace_system_description_description (LttSystemDescription
* s
)
2428 return s
->description
;
2432 /* get the start time of the trace */
2434 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
)
2436 return s
->trace_start
;
2440 LttTracefile
*ltt_tracefile_new()
2442 return g_new(LttTracefile
, 1);
2445 void ltt_tracefile_destroy(LttTracefile
*tf
)
2450 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
)
2455 /* Before library loading... */
2457 static void __attribute__((constructor
)) init(void)
2459 LTT_FACILITY_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2460 LTT_EVENT_NAME_HEARTBEAT
= g_quark_from_string("heartbeat");
2462 LTT_TRACEFILE_NAME_FACILITIES
= g_quark_from_string("/control/facilities");