(usage): Fix description of --special-syms switch.
[binutils.git] / gprof / gmon_io.c
blob6261d46b12c78fc8f59e8ec00592fa1aae3d7d96
1 /* gmon_io.c - Input and output from/to gmon.out files.
3 Copyright 2000, 2001, 2002 Free Software Foundation, Inc.
5 This file is part of GNU Binutils.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #include "gprof.h"
23 #include "search_list.h"
24 #include "source.h"
25 #include "symtab.h"
26 #include "cg_arcs.h"
27 #include "basic_blocks.h"
28 #include "corefile.h"
29 #include "call_graph.h"
30 #include "gmon_io.h"
31 #include "gmon_out.h"
32 #include "gmon.h" /* Fetch header for old format. */
33 #include "hertz.h"
34 #include "hist.h"
35 #include "libiberty.h"
37 enum gmon_ptr_size {
38 ptr_32bit,
39 ptr_64bit
42 enum gmon_ptr_signedness {
43 ptr_signed,
44 ptr_unsigned
47 static enum gmon_ptr_size gmon_get_ptr_size (void);
48 static enum gmon_ptr_signedness gmon_get_ptr_signedness (void);
50 #ifdef BFD_HOST_U_64_BIT
51 static int gmon_io_read_64 (FILE *, BFD_HOST_U_64_BIT *);
52 static int gmon_io_write_64 (FILE *, BFD_HOST_U_64_BIT);
53 #endif
54 static int gmon_read_raw_arc
55 (FILE *, bfd_vma *, bfd_vma *, unsigned long *);
56 static int gmon_write_raw_arc
57 (FILE *, bfd_vma, bfd_vma, unsigned long);
59 int gmon_input = 0;
60 int gmon_file_version = 0; /* 0 == old (non-versioned) file format. */
62 static enum gmon_ptr_size
63 gmon_get_ptr_size ()
65 int size;
67 /* Pick best size for pointers. Start with the ELF size, and if not
68 elf go with the architecture's address size. */
69 size = bfd_get_arch_size (core_bfd);
70 if (size == -1)
71 size = bfd_arch_bits_per_address (core_bfd);
73 switch (size)
75 case 32:
76 return ptr_32bit;
78 case 64:
79 return ptr_64bit;
81 default:
82 fprintf (stderr, _("%s: address size has unexpected value of %u\n"),
83 whoami, size);
84 done (1);
88 static enum gmon_ptr_signedness
89 gmon_get_ptr_signedness ()
91 int sext;
93 /* Figure out whether to sign extend. If BFD doesn't know, assume no. */
94 sext = bfd_get_sign_extend_vma (core_bfd);
95 if (sext == -1)
96 return ptr_unsigned;
97 return (sext ? ptr_signed : ptr_unsigned);
101 gmon_io_read_32 (FILE *ifp, unsigned int *valp)
103 char buf[4];
105 if (fread (buf, 1, 4, ifp) != 4)
106 return 1;
107 *valp = bfd_get_32 (core_bfd, buf);
108 return 0;
111 #ifdef BFD_HOST_U_64_BIT
112 static int
113 gmon_io_read_64 (FILE *ifp, BFD_HOST_U_64_BIT *valp)
115 char buf[8];
117 if (fread (buf, 1, 8, ifp) != 8)
118 return 1;
119 *valp = bfd_get_64 (core_bfd, buf);
120 return 0;
122 #endif
125 gmon_io_read_vma (FILE *ifp, bfd_vma *valp)
127 unsigned int val32;
128 #ifdef BFD_HOST_U_64_BIT
129 BFD_HOST_U_64_BIT val64;
130 #endif
132 switch (gmon_get_ptr_size ())
134 case ptr_32bit:
135 if (gmon_io_read_32 (ifp, &val32))
136 return 1;
137 if (gmon_get_ptr_signedness () == ptr_signed)
138 *valp = (int) val32;
139 else
140 *valp = val32;
141 break;
143 #ifdef BFD_HOST_U_64_BIT
144 case ptr_64bit:
145 if (gmon_io_read_64 (ifp, &val64))
146 return 1;
147 #ifdef BFD_HOST_64_BIT
148 if (gmon_get_ptr_signedness () == ptr_signed)
149 *valp = (BFD_HOST_64_BIT) val64;
150 else
151 #endif
152 *valp = val64;
153 break;
154 #endif
156 return 0;
160 gmon_io_read (FILE *ifp, char *buf, size_t n)
162 if (fread (buf, 1, n, ifp) != n)
163 return 1;
164 return 0;
168 gmon_io_write_32 (FILE *ofp, unsigned int val)
170 char buf[4];
172 bfd_put_32 (core_bfd, (bfd_vma) val, buf);
173 if (fwrite (buf, 1, 4, ofp) != 4)
174 return 1;
175 return 0;
178 #ifdef BFD_HOST_U_64_BIT
179 static int
180 gmon_io_write_64 (FILE *ofp, BFD_HOST_U_64_BIT val)
182 char buf[8];
184 bfd_put_64 (core_bfd, (bfd_vma) val, buf);
185 if (fwrite (buf, 1, 8, ofp) != 8)
186 return 1;
187 return 0;
189 #endif
192 gmon_io_write_vma (FILE *ofp, bfd_vma val)
195 switch (gmon_get_ptr_size ())
197 case ptr_32bit:
198 if (gmon_io_write_32 (ofp, (unsigned int) val))
199 return 1;
200 break;
202 #ifdef BFD_HOST_U_64_BIT
203 case ptr_64bit:
204 if (gmon_io_write_64 (ofp, (BFD_HOST_U_64_BIT) val))
205 return 1;
206 break;
207 #endif
209 return 0;
213 gmon_io_write_8 (FILE *ofp, unsigned int val)
215 char buf[1];
217 bfd_put_8 (core_bfd, val, buf);
218 if (fwrite (buf, 1, 1, ofp) != 1)
219 return 1;
220 return 0;
224 gmon_io_write (FILE *ofp, char *buf, size_t n)
226 if (fwrite (buf, 1, n, ofp) != n)
227 return 1;
228 return 0;
231 static int
232 gmon_read_raw_arc (FILE *ifp, bfd_vma *fpc, bfd_vma *spc, unsigned long *cnt)
234 #ifdef BFD_HOST_U_64_BIT
235 BFD_HOST_U_64_BIT cnt64;
236 #endif
237 unsigned int cnt32;
239 if (gmon_io_read_vma (ifp, fpc)
240 || gmon_io_read_vma (ifp, spc))
241 return 1;
243 switch (gmon_get_ptr_size ())
245 case ptr_32bit:
246 if (gmon_io_read_32 (ifp, &cnt32))
247 return 1;
248 *cnt = cnt32;
249 break;
251 #ifdef BFD_HOST_U_64_BIT
252 case ptr_64bit:
253 if (gmon_io_read_64 (ifp, &cnt64))
254 return 1;
255 *cnt = cnt64;
256 break;
257 #endif
259 return 0;
262 static int
263 gmon_write_raw_arc (FILE *ofp, bfd_vma fpc, bfd_vma spc, unsigned long cnt)
266 if (gmon_io_write_vma (ofp, fpc)
267 || gmon_io_write_vma (ofp, spc))
268 return 1;
270 switch (gmon_get_ptr_size ())
272 case ptr_32bit:
273 if (gmon_io_write_32 (ofp, (unsigned int) cnt))
274 return 1;
275 break;
277 #ifdef BFD_HOST_U_64_BIT
278 case ptr_64bit:
279 if (gmon_io_write_64 (ofp, (BFD_HOST_U_64_BIT) cnt))
280 return 1;
281 break;
282 #endif
284 return 0;
287 void
288 gmon_out_read (const char *filename)
290 FILE *ifp;
291 struct gmon_hdr ghdr;
292 unsigned char tag;
293 int nhist = 0, narcs = 0, nbbs = 0;
295 /* Open gmon.out file. */
296 if (strcmp (filename, "-") == 0)
298 ifp = stdin;
299 #ifdef SET_BINARY
300 SET_BINARY (fileno (stdin));
301 #endif
303 else
305 ifp = fopen (filename, FOPEN_RB);
307 if (!ifp)
309 perror (filename);
310 done (1);
314 if (fread (&ghdr, sizeof (struct gmon_hdr), 1, ifp) != 1)
316 fprintf (stderr, _("%s: file too short to be a gmon file\n"),
317 filename);
318 done (1);
321 if ((file_format == FF_MAGIC)
322 || (file_format == FF_AUTO && !strncmp (&ghdr.cookie[0], GMON_MAGIC, 4)))
324 if (file_format == FF_MAGIC && strncmp (&ghdr.cookie[0], GMON_MAGIC, 4))
326 fprintf (stderr, _("%s: file `%s' has bad magic cookie\n"),
327 whoami, filename);
328 done (1);
331 /* Right magic, so it's probably really a new gmon.out file. */
332 gmon_file_version = bfd_get_32 (core_bfd, (bfd_byte *) ghdr.version);
334 if (gmon_file_version != GMON_VERSION && gmon_file_version != 0)
336 fprintf (stderr,
337 _("%s: file `%s' has unsupported version %d\n"),
338 whoami, filename, gmon_file_version);
339 done (1);
342 /* Read in all the records. */
343 while (fread (&tag, sizeof (tag), 1, ifp) == 1)
345 switch (tag)
347 case GMON_TAG_TIME_HIST:
348 ++nhist;
349 gmon_input |= INPUT_HISTOGRAM;
350 hist_read_rec (ifp, filename);
351 break;
353 case GMON_TAG_CG_ARC:
354 ++narcs;
355 gmon_input |= INPUT_CALL_GRAPH;
356 cg_read_rec (ifp, filename);
357 break;
359 case GMON_TAG_BB_COUNT:
360 ++nbbs;
361 gmon_input |= INPUT_BB_COUNTS;
362 bb_read_rec (ifp, filename);
363 break;
365 default:
366 fprintf (stderr,
367 _("%s: %s: found bad tag %d (file corrupted?)\n"),
368 whoami, filename, tag);
369 done (1);
373 else if (file_format == FF_AUTO
374 || file_format == FF_BSD
375 || file_format == FF_BSD44)
377 struct hdr
379 bfd_vma low_pc;
380 bfd_vma high_pc;
381 int ncnt;
383 int i, samp_bytes, header_size = 0;
384 unsigned long count;
385 bfd_vma from_pc, self_pc;
386 static struct hdr h;
387 UNIT raw_bin_count;
388 struct hdr tmp;
389 int version;
391 /* Information from a gmon.out file is in two parts: an array of
392 sampling hits within pc ranges, and the arcs. */
393 gmon_input = INPUT_HISTOGRAM | INPUT_CALL_GRAPH;
395 /* This fseek() ought to work even on stdin as long as it's
396 not an interactive device (heck, is there anybody who would
397 want to type in a gmon.out at the terminal?). */
398 if (fseek (ifp, 0, SEEK_SET) < 0)
400 perror (filename);
401 done (1);
404 /* The beginning of the old BSD header and the 4.4BSD header
405 are the same: lowpc, highpc, ncnt */
406 if (gmon_io_read_vma (ifp, &tmp.low_pc)
407 || gmon_io_read_vma (ifp, &tmp.high_pc)
408 || gmon_io_read_32 (ifp, &tmp.ncnt))
410 bad_gmon_file:
411 fprintf (stderr, _("%s: file too short to be a gmon file\n"),
412 filename);
413 done (1);
416 /* Check to see if this a 4.4BSD-style header. */
417 if (gmon_io_read_32 (ifp, &version))
418 goto bad_gmon_file;
420 if (version == GMONVERSION)
422 int profrate;
424 /* 4.4BSD format header. */
425 if (gmon_io_read_32 (ifp, &profrate))
426 goto bad_gmon_file;
428 if (!s_highpc)
429 hz = profrate;
430 else if (hz != profrate)
432 fprintf (stderr,
433 _("%s: profiling rate incompatible with first gmon file\n"),
434 filename);
435 done (1);
438 switch (gmon_get_ptr_size ())
440 case ptr_32bit:
441 header_size = GMON_HDRSIZE_BSD44_32;
442 break;
444 case ptr_64bit:
445 header_size = GMON_HDRSIZE_BSD44_64;
446 break;
449 else
451 /* Old style BSD format. */
452 if (file_format == FF_BSD44)
454 fprintf (stderr, _("%s: file `%s' has bad magic cookie\n"),
455 whoami, filename);
456 done (1);
459 switch (gmon_get_ptr_size ())
461 case ptr_32bit:
462 header_size = GMON_HDRSIZE_OLDBSD_32;
463 break;
465 case ptr_64bit:
466 header_size = GMON_HDRSIZE_OLDBSD_64;
467 break;
471 /* Position the file to after the header. */
472 if (fseek (ifp, header_size, SEEK_SET) < 0)
474 perror (filename);
475 done (1);
478 if (s_highpc && (tmp.low_pc != h.low_pc
479 || tmp.high_pc != h.high_pc || tmp.ncnt != h.ncnt))
481 fprintf (stderr, _("%s: incompatible with first gmon file\n"),
482 filename);
483 done (1);
486 h = tmp;
487 s_lowpc = (bfd_vma) h.low_pc;
488 s_highpc = (bfd_vma) h.high_pc;
489 lowpc = (bfd_vma) h.low_pc / sizeof (UNIT);
490 highpc = (bfd_vma) h.high_pc / sizeof (UNIT);
491 samp_bytes = h.ncnt - header_size;
492 hist_num_bins = samp_bytes / sizeof (UNIT);
494 DBG (SAMPLEDEBUG,
495 printf ("[gmon_out_read] lowpc 0x%lx highpc 0x%lx ncnt %d\n",
496 (unsigned long) h.low_pc, (unsigned long) h.high_pc,
497 h.ncnt);
498 printf ("[gmon_out_read] s_lowpc 0x%lx s_highpc 0x%lx\n",
499 (unsigned long) s_lowpc, (unsigned long) s_highpc);
500 printf ("[gmon_out_read] lowpc 0x%lx highpc 0x%lx\n",
501 (unsigned long) lowpc, (unsigned long) highpc);
502 printf ("[gmon_out_read] samp_bytes %d hist_num_bins %d\n",
503 samp_bytes, hist_num_bins));
505 /* Make sure that we have sensible values. */
506 if (samp_bytes < 0 || lowpc > highpc)
508 fprintf (stderr,
509 _("%s: file '%s' does not appear to be in gmon.out format\n"),
510 whoami, filename);
511 done (1);
514 if (hist_num_bins)
515 ++nhist;
517 if (!hist_sample)
519 hist_sample =
520 (int *) xmalloc (hist_num_bins * sizeof (hist_sample[0]));
522 memset (hist_sample, 0, hist_num_bins * sizeof (hist_sample[0]));
525 for (i = 0; i < hist_num_bins; ++i)
527 if (fread (raw_bin_count, sizeof (raw_bin_count), 1, ifp) != 1)
529 fprintf (stderr,
530 _("%s: unexpected EOF after reading %d/%d bins\n"),
531 whoami, --i, hist_num_bins);
532 done (1);
535 hist_sample[i] += bfd_get_16 (core_bfd, (bfd_byte *) raw_bin_count);
538 /* The rest of the file consists of a bunch of
539 <from,self,count> tuples. */
540 while (gmon_read_raw_arc (ifp, &from_pc, &self_pc, &count) == 0)
542 ++narcs;
544 DBG (SAMPLEDEBUG,
545 printf ("[gmon_out_read] frompc 0x%lx selfpc 0x%lx count %lu\n",
546 (unsigned long) from_pc, (unsigned long) self_pc, count));
548 /* Add this arc. */
549 cg_tally (from_pc, self_pc, count);
552 fclose (ifp);
554 if (hz == HZ_WRONG)
556 /* How many ticks per second? If we can't tell, report
557 time in ticks. */
558 hz = hertz ();
560 if (hz == HZ_WRONG)
562 hz = 1;
563 fprintf (stderr, _("time is in ticks, not seconds\n"));
567 else
569 fprintf (stderr, _("%s: don't know how to deal with file format %d\n"),
570 whoami, file_format);
571 done (1);
574 if (output_style & STYLE_GMON_INFO)
576 printf (_("File `%s' (version %d) contains:\n"),
577 filename, gmon_file_version);
578 printf (nhist == 1 ?
579 _("\t%d histogram record\n") :
580 _("\t%d histogram records\n"), nhist);
581 printf (narcs == 1 ?
582 _("\t%d call-graph record\n") :
583 _("\t%d call-graph records\n"), narcs);
584 printf (nbbs == 1 ?
585 _("\t%d basic-block count record\n") :
586 _("\t%d basic-block count records\n"), nbbs);
587 first_output = FALSE;
592 void
593 gmon_out_write (const char *filename)
595 FILE *ofp;
596 struct gmon_hdr ghdr;
598 ofp = fopen (filename, FOPEN_WB);
599 if (!ofp)
601 perror (filename);
602 done (1);
605 if (file_format == FF_AUTO || file_format == FF_MAGIC)
607 /* Write gmon header. */
609 memcpy (&ghdr.cookie[0], GMON_MAGIC, 4);
610 bfd_put_32 (core_bfd, (bfd_vma) GMON_VERSION, (bfd_byte *) ghdr.version);
612 if (fwrite (&ghdr, sizeof (ghdr), 1, ofp) != 1)
614 perror (filename);
615 done (1);
618 /* Write execution time histogram if we have one. */
619 if (gmon_input & INPUT_HISTOGRAM)
620 hist_write_hist (ofp, filename);
622 /* Write call graph arcs if we have any. */
623 if (gmon_input & INPUT_CALL_GRAPH)
624 cg_write_arcs (ofp, filename);
626 /* Write basic-block info if we have it. */
627 if (gmon_input & INPUT_BB_COUNTS)
628 bb_write_blocks (ofp, filename);
630 else if (file_format == FF_BSD || file_format == FF_BSD44)
632 UNIT raw_bin_count;
633 int i, hdrsize;
634 unsigned padsize;
635 char pad[3*4];
636 Arc *arc;
637 Sym *sym;
639 memset (pad, 0, sizeof (pad));
641 hdrsize = 0;
642 /* Decide how large the header will be. Use the 4.4BSD format
643 header if explicitly specified, or if the profiling rate is
644 non-standard. Otherwise, use the old BSD format. */
645 if (file_format == FF_BSD44
646 || hz != hertz())
648 padsize = 3*4;
649 switch (gmon_get_ptr_size ())
651 case ptr_32bit:
652 hdrsize = GMON_HDRSIZE_BSD44_32;
653 break;
655 case ptr_64bit:
656 hdrsize = GMON_HDRSIZE_BSD44_64;
657 break;
660 else
662 padsize = 0;
663 switch (gmon_get_ptr_size ())
665 case ptr_32bit:
666 hdrsize = GMON_HDRSIZE_OLDBSD_32;
667 break;
669 case ptr_64bit:
670 hdrsize = GMON_HDRSIZE_OLDBSD_64;
671 /* FIXME: Checking host compiler defines here means that we can't
672 use a cross gprof alpha OSF. */
673 #if defined(__alpha__) && defined (__osf__)
674 padsize = 4;
675 #endif
676 break;
680 /* Write the parts of the headers that are common to both the
681 old BSD and 4.4BSD formats. */
682 if (gmon_io_write_vma (ofp, s_lowpc)
683 || gmon_io_write_vma (ofp, s_highpc)
684 || gmon_io_write_32 (ofp, hist_num_bins * sizeof (UNIT) + hdrsize))
686 perror (filename);
687 done (1);
690 /* Write out the 4.4BSD header bits, if that's what we're using. */
691 if (file_format == FF_BSD44
692 || hz != hertz())
694 if (gmon_io_write_32 (ofp, GMONVERSION)
695 || gmon_io_write_32 (ofp, (unsigned int) hz))
697 perror (filename);
698 done (1);
702 /* Now write out any necessary padding after the meaningful
703 header bits. */
704 if (padsize != 0
705 && fwrite (pad, 1, padsize, ofp) != padsize)
707 perror (filename);
708 done (1);
711 /* Dump the samples. */
712 for (i = 0; i < hist_num_bins; ++i)
714 bfd_put_16 (core_bfd, (bfd_vma) hist_sample[i],
715 (bfd_byte *) &raw_bin_count[0]);
716 if (fwrite (&raw_bin_count[0], sizeof (raw_bin_count), 1, ofp) != 1)
718 perror (filename);
719 done (1);
723 /* Dump the normalized raw arc information. */
724 for (sym = symtab.base; sym < symtab.limit; ++sym)
726 for (arc = sym->cg.children; arc; arc = arc->next_child)
728 if (gmon_write_raw_arc (ofp, arc->parent->addr,
729 arc->child->addr, arc->count))
731 perror (filename);
732 done (1);
734 DBG (SAMPLEDEBUG,
735 printf ("[dumpsum] frompc 0x%lx selfpc 0x%lx count %lu\n",
736 (unsigned long) arc->parent->addr,
737 (unsigned long) arc->child->addr, arc->count));
741 fclose (ofp);
743 else
745 fprintf (stderr, _("%s: don't know how to deal with file format %d\n"),
746 whoami, file_format);
747 done (1);