1
/* gmon_io.c - Input and output from/to gmon.out files.
3
Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
4
Free Software Foundation, Inc.
6
This file is part of GNU Binutils.
8
This program is free software; you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation; either version 3 of the License, or
11
(at your option) any later version.
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
18
You should have received a copy of the GNU General Public License
19
along with this program; if not, write to the Free Software
20
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
24
#include "binary-io.h"
25
#include "search_list.h"
29
#include "basic_blocks.h"
31
#include "call_graph.h"
34
#include "gmon.h" /* Fetch header for old format. */
37
#include "libiberty.h"
44
enum gmon_ptr_signedness {
49
static enum gmon_ptr_size gmon_get_ptr_size (void);
50
static enum gmon_ptr_signedness gmon_get_ptr_signedness (void);
52
#ifdef BFD_HOST_U_64_BIT
53
static int gmon_io_read_64 (FILE *, BFD_HOST_U_64_BIT *);
54
static int gmon_io_write_64 (FILE *, BFD_HOST_U_64_BIT);
56
static int gmon_read_raw_arc
57
(FILE *, bfd_vma *, bfd_vma *, unsigned long *);
58
static int gmon_write_raw_arc
59
(FILE *, bfd_vma, bfd_vma, unsigned long);
62
int gmon_file_version = 0; /* 0 == old (non-versioned) file format. */
64
static enum gmon_ptr_size
69
/* Pick best size for pointers. Start with the ELF size, and if not
70
elf go with the architecture's address size. */
71
size = bfd_get_arch_size (core_bfd);
73
size = bfd_arch_bits_per_address (core_bfd);
84
fprintf (stderr, _("%s: address size has unexpected value of %u\n"),
90
static enum gmon_ptr_signedness
91
gmon_get_ptr_signedness ()
95
/* Figure out whether to sign extend. If BFD doesn't know, assume no. */
96
sext = bfd_get_sign_extend_vma (core_bfd);
99
return (sext ? ptr_signed : ptr_unsigned);
103
gmon_io_read_32 (FILE *ifp, unsigned int *valp)
107
if (fread (buf, 1, 4, ifp) != 4)
109
*valp = bfd_get_32 (core_bfd, buf);
113
#ifdef BFD_HOST_U_64_BIT
115
gmon_io_read_64 (FILE *ifp, BFD_HOST_U_64_BIT *valp)
119
if (fread (buf, 1, 8, ifp) != 8)
121
*valp = bfd_get_64 (core_bfd, buf);
127
gmon_io_read_vma (FILE *ifp, bfd_vma *valp)
130
#ifdef BFD_HOST_U_64_BIT
131
BFD_HOST_U_64_BIT val64;
134
switch (gmon_get_ptr_size ())
137
if (gmon_io_read_32 (ifp, &val32))
139
if (gmon_get_ptr_signedness () == ptr_signed)
145
#ifdef BFD_HOST_U_64_BIT
147
if (gmon_io_read_64 (ifp, &val64))
149
#ifdef BFD_HOST_64_BIT
150
if (gmon_get_ptr_signedness () == ptr_signed)
151
*valp = (BFD_HOST_64_BIT) val64;
162
gmon_io_read (FILE *ifp, char *buf, size_t n)
164
if (fread (buf, 1, n, ifp) != n)
170
gmon_io_write_32 (FILE *ofp, unsigned int val)
174
bfd_put_32 (core_bfd, (bfd_vma) val, buf);
175
if (fwrite (buf, 1, 4, ofp) != 4)
180
#ifdef BFD_HOST_U_64_BIT
182
gmon_io_write_64 (FILE *ofp, BFD_HOST_U_64_BIT val)
186
bfd_put_64 (core_bfd, (bfd_vma) val, buf);
187
if (fwrite (buf, 1, 8, ofp) != 8)
194
gmon_io_write_vma (FILE *ofp, bfd_vma val)
197
switch (gmon_get_ptr_size ())
200
if (gmon_io_write_32 (ofp, (unsigned int) val))
204
#ifdef BFD_HOST_U_64_BIT
206
if (gmon_io_write_64 (ofp, (BFD_HOST_U_64_BIT) val))
215
gmon_io_write_8 (FILE *ofp, unsigned int val)
219
bfd_put_8 (core_bfd, val, buf);
220
if (fwrite (buf, 1, 1, ofp) != 1)
226
gmon_io_write (FILE *ofp, char *buf, size_t n)
228
if (fwrite (buf, 1, n, ofp) != n)
234
gmon_read_raw_arc (FILE *ifp, bfd_vma *fpc, bfd_vma *spc, unsigned long *cnt)
236
#ifdef BFD_HOST_U_64_BIT
237
BFD_HOST_U_64_BIT cnt64;
241
if (gmon_io_read_vma (ifp, fpc)
242
|| gmon_io_read_vma (ifp, spc))
245
switch (gmon_get_ptr_size ())
248
if (gmon_io_read_32 (ifp, &cnt32))
253
#ifdef BFD_HOST_U_64_BIT
255
if (gmon_io_read_64 (ifp, &cnt64))
268
gmon_write_raw_arc (FILE *ofp, bfd_vma fpc, bfd_vma spc, unsigned long cnt)
271
if (gmon_io_write_vma (ofp, fpc)
272
|| gmon_io_write_vma (ofp, spc))
275
switch (gmon_get_ptr_size ())
278
if (gmon_io_write_32 (ofp, (unsigned int) cnt))
282
#ifdef BFD_HOST_U_64_BIT
284
if (gmon_io_write_64 (ofp, (BFD_HOST_U_64_BIT) cnt))
293
gmon_out_read (const char *filename)
296
struct gmon_hdr ghdr;
298
int nhist = 0, narcs = 0, nbbs = 0;
300
/* Open gmon.out file. */
301
if (strcmp (filename, "-") == 0)
304
SET_BINARY (fileno (stdin));
308
ifp = fopen (filename, FOPEN_RB);
317
if (fread (&ghdr, sizeof (struct gmon_hdr), 1, ifp) != 1)
319
fprintf (stderr, _("%s: file too short to be a gmon file\n"),
324
if ((file_format == FF_MAGIC)
325
|| (file_format == FF_AUTO && !strncmp (&ghdr.cookie[0], GMON_MAGIC, 4)))
327
if (file_format == FF_MAGIC && strncmp (&ghdr.cookie[0], GMON_MAGIC, 4))
329
fprintf (stderr, _("%s: file `%s' has bad magic cookie\n"),
334
/* Right magic, so it's probably really a new gmon.out file. */
335
gmon_file_version = bfd_get_32 (core_bfd, (bfd_byte *) ghdr.version);
337
if (gmon_file_version != GMON_VERSION && gmon_file_version != 0)
340
_("%s: file `%s' has unsupported version %d\n"),
341
whoami, filename, gmon_file_version);
345
/* Read in all the records. */
346
while (fread (&tag, sizeof (tag), 1, ifp) == 1)
350
case GMON_TAG_TIME_HIST:
352
gmon_input |= INPUT_HISTOGRAM;
353
hist_read_rec (ifp, filename);
356
case GMON_TAG_CG_ARC:
358
gmon_input |= INPUT_CALL_GRAPH;
359
cg_read_rec (ifp, filename);
362
case GMON_TAG_BB_COUNT:
364
gmon_input |= INPUT_BB_COUNTS;
365
bb_read_rec (ifp, filename);
370
_("%s: %s: found bad tag %d (file corrupted?)\n"),
371
whoami, filename, tag);
376
else if (file_format == FF_AUTO
377
|| file_format == FF_BSD
378
|| file_format == FF_BSD44)
387
int samp_bytes, header_size = 0;
389
bfd_vma from_pc, self_pc;
392
unsigned int version;
393
unsigned int hist_num_bins;
395
/* Information from a gmon.out file is in two parts: an array of
396
sampling hits within pc ranges, and the arcs. */
397
gmon_input = INPUT_HISTOGRAM | INPUT_CALL_GRAPH;
399
/* This fseek() ought to work even on stdin as long as it's
400
not an interactive device (heck, is there anybody who would
401
want to type in a gmon.out at the terminal?). */
402
if (fseek (ifp, 0, SEEK_SET) < 0)
408
/* The beginning of the old BSD header and the 4.4BSD header
409
are the same: lowpc, highpc, ncnt */
410
if (gmon_io_read_vma (ifp, &tmp.low_pc)
411
|| gmon_io_read_vma (ifp, &tmp.high_pc)
412
|| gmon_io_read_32 (ifp, &tmp.ncnt))
415
fprintf (stderr, _("%s: file too short to be a gmon file\n"),
420
/* Check to see if this a 4.4BSD-style header. */
421
if (gmon_io_read_32 (ifp, &version))
424
if (version == GMONVERSION)
426
unsigned int profrate;
428
/* 4.4BSD format header. */
429
if (gmon_io_read_32 (ifp, &profrate))
434
else if (hz != (int) profrate)
437
_("%s: profiling rate incompatible with first gmon file\n"),
442
switch (gmon_get_ptr_size ())
445
header_size = GMON_HDRSIZE_BSD44_32;
449
header_size = GMON_HDRSIZE_BSD44_64;
455
/* Old style BSD format. */
456
if (file_format == FF_BSD44)
458
fprintf (stderr, _("%s: file `%s' has bad magic cookie\n"),
463
switch (gmon_get_ptr_size ())
466
header_size = GMON_HDRSIZE_OLDBSD_32;
470
header_size = GMON_HDRSIZE_OLDBSD_64;
475
/* Position the file to after the header. */
476
if (fseek (ifp, header_size, SEEK_SET) < 0)
482
samp_bytes = tmp.ncnt - header_size;
483
hist_num_bins = samp_bytes / sizeof (UNIT);
484
if (histograms && (tmp.low_pc != histograms->lowpc
485
|| tmp.high_pc != histograms->highpc
486
|| (hist_num_bins != histograms->num_bins)))
488
fprintf (stderr, _("%s: incompatible with first gmon file\n"),
496
histograms = (struct histogram *) xmalloc (sizeof (struct histogram));
497
histograms->lowpc = tmp.low_pc;
498
histograms->highpc = tmp.high_pc;
499
histograms->num_bins = hist_num_bins;
500
hist_scale = (double)((tmp.high_pc - tmp.low_pc) / sizeof (UNIT))
502
histograms->sample = (int *) xmalloc (hist_num_bins * sizeof (int));
503
memset (histograms->sample, 0,
504
hist_num_bins * sizeof (int));
508
printf ("[gmon_out_read] lowpc 0x%lx highpc 0x%lx ncnt %d\n",
509
(unsigned long) tmp.low_pc, (unsigned long) tmp.high_pc,
511
printf ("[gmon_out_read] samp_bytes %d hist_num_bins %d\n",
512
samp_bytes, hist_num_bins));
514
/* Make sure that we have sensible values. */
515
if (samp_bytes < 0 || histograms->lowpc > histograms->highpc)
518
_("%s: file '%s' does not appear to be in gmon.out format\n"),
526
for (i = 0; i < hist_num_bins; ++i)
528
if (fread (raw_bin_count, sizeof (raw_bin_count), 1, ifp) != 1)
531
_("%s: unexpected EOF after reading %d/%d bins\n"),
532
whoami, --i, hist_num_bins);
536
histograms->sample[i]
537
+= bfd_get_16 (core_bfd, (bfd_byte *) raw_bin_count);
540
/* The rest of the file consists of a bunch of
541
<from,self,count> tuples. */
542
while (gmon_read_raw_arc (ifp, &from_pc, &self_pc, &count) == 0)
547
printf ("[gmon_out_read] frompc 0x%lx selfpc 0x%lx count %lu\n",
548
(unsigned long) from_pc, (unsigned long) self_pc, count));
551
cg_tally (from_pc, self_pc, count);
556
/* How many ticks per second? If we can't tell, report
563
fprintf (stderr, _("time is in ticks, not seconds\n"));
569
fprintf (stderr, _("%s: don't know how to deal with file format %d\n"),
570
whoami, file_format);
577
if (output_style & STYLE_GMON_INFO)
579
printf (_("File `%s' (version %d) contains:\n"),
580
filename, gmon_file_version);
582
_("\t%d histogram record\n") :
583
_("\t%d histogram records\n"), nhist);
585
_("\t%d call-graph record\n") :
586
_("\t%d call-graph records\n"), narcs);
588
_("\t%d basic-block count record\n") :
589
_("\t%d basic-block count records\n"), nbbs);
590
first_output = FALSE;
596
gmon_out_write (const char *filename)
599
struct gmon_hdr ghdr;
601
ofp = fopen (filename, FOPEN_WB);
608
if (file_format == FF_AUTO || file_format == FF_MAGIC)
610
/* Write gmon header. */
612
memcpy (&ghdr.cookie[0], GMON_MAGIC, 4);
613
bfd_put_32 (core_bfd, (bfd_vma) GMON_VERSION, (bfd_byte *) ghdr.version);
615
if (fwrite (&ghdr, sizeof (ghdr), 1, ofp) != 1)
621
/* Write execution time histogram if we have one. */
622
if (gmon_input & INPUT_HISTOGRAM)
623
hist_write_hist (ofp, filename);
625
/* Write call graph arcs if we have any. */
626
if (gmon_input & INPUT_CALL_GRAPH)
627
cg_write_arcs (ofp, filename);
629
/* Write basic-block info if we have it. */
630
if (gmon_input & INPUT_BB_COUNTS)
631
bb_write_blocks (ofp, filename);
633
else if (file_format == FF_BSD || file_format == FF_BSD44)
636
unsigned int i, hdrsize;
642
memset (pad, 0, sizeof (pad));
645
/* Decide how large the header will be. Use the 4.4BSD format
646
header if explicitly specified, or if the profiling rate is
647
non-standard. Otherwise, use the old BSD format. */
648
if (file_format == FF_BSD44
652
switch (gmon_get_ptr_size ())
655
hdrsize = GMON_HDRSIZE_BSD44_32;
659
hdrsize = GMON_HDRSIZE_BSD44_64;
666
switch (gmon_get_ptr_size ())
669
hdrsize = GMON_HDRSIZE_OLDBSD_32;
673
hdrsize = GMON_HDRSIZE_OLDBSD_64;
674
/* FIXME: Checking host compiler defines here means that we can't
675
use a cross gprof alpha OSF. */
676
#if defined(__alpha__) && defined (__osf__)
683
/* Write the parts of the headers that are common to both the
684
old BSD and 4.4BSD formats. */
685
if (gmon_io_write_vma (ofp, histograms->lowpc)
686
|| gmon_io_write_vma (ofp, histograms->highpc)
687
|| gmon_io_write_32 (ofp, histograms->num_bins
688
* sizeof (UNIT) + hdrsize))
694
/* Write out the 4.4BSD header bits, if that's what we're using. */
695
if (file_format == FF_BSD44
698
if (gmon_io_write_32 (ofp, GMONVERSION)
699
|| gmon_io_write_32 (ofp, (unsigned int) hz))
706
/* Now write out any necessary padding after the meaningful
709
&& fwrite (pad, 1, padsize, ofp) != padsize)
715
/* Dump the samples. */
716
for (i = 0; i < histograms->num_bins; ++i)
718
bfd_put_16 (core_bfd, (bfd_vma) histograms->sample[i],
719
(bfd_byte *) &raw_bin_count[0]);
720
if (fwrite (&raw_bin_count[0], sizeof (raw_bin_count), 1, ofp) != 1)
727
/* Dump the normalized raw arc information. */
728
for (sym = symtab.base; sym < symtab.limit; ++sym)
730
for (arc = sym->cg.children; arc; arc = arc->next_child)
732
if (gmon_write_raw_arc (ofp, arc->parent->addr,
733
arc->child->addr, arc->count))
739
printf ("[dumpsum] frompc 0x%lx selfpc 0x%lx count %lu\n",
740
(unsigned long) arc->parent->addr,
741
(unsigned long) arc->child->addr, arc->count));
749
fprintf (stderr, _("%s: don't know how to deal with file format %d\n"),
750
whoami, file_format);