1 /* basic_blocks.c - Basic-block level related code: reading/writing
2 of basic-block info to/from gmon.out; computing and formatting of
3 basic-block related statistics.
5 Copyright (C) 1999-2023 Free Software Foundation, Inc.
7 This file is part of GNU Binutils.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
25 #include "libiberty.h"
26 #include "filenames.h"
27 #include "basic_blocks.h"
31 #include "search_list.h"
36 static int cmp_bb (const void *, const void *);
37 static int cmp_ncalls (const void *, const void *);
38 static void fskip_string (FILE *);
39 static void annotate_with_count (char *, unsigned int, int, void *);
41 /* Default option values: */
42 bool bb_annotate_all_lines
= false;
43 unsigned long bb_min_calls
= 1;
44 int bb_table_length
= 10;
46 /* Variables used to compute annotated source listing stats: */
47 static long num_executable_lines
;
48 static long num_lines_executed
;
51 /* Helper for sorting. Compares two symbols and returns result
52 such that sorting will be increasing according to filename, line
53 number, and address (in that order). */
56 cmp_bb (const void *lp
, const void *rp
)
59 const Sym
*left
= *(const Sym
**) lp
;
60 const Sym
*right
= *(const Sym
**) rp
;
62 if (left
->file
&& right
->file
)
64 r
= filename_cmp (left
->file
->name
, right
->file
->name
);
69 if (left
->line_num
!= right
->line_num
)
70 return left
->line_num
- right
->line_num
;
73 if (left
->addr
< right
->addr
)
75 else if (left
->addr
> right
->addr
)
82 /* Helper for sorting. Order basic blocks in decreasing number of
83 calls, ties are broken in increasing order of line numbers. */
85 cmp_ncalls (const void *lp
, const void *rp
)
87 const Sym
*left
= *(const Sym
**) lp
;
88 const Sym
*right
= *(const Sym
**) rp
;
95 if (left
->ncalls
< right
->ncalls
)
97 else if (left
->ncalls
> right
->ncalls
)
100 return left
->line_num
- right
->line_num
;
103 /* Skip over variable length string. */
105 fskip_string (FILE *fp
)
109 while ((ch
= fgetc (fp
)) != EOF
)
116 /* Read a basic-block record from file IFP. FILENAME is the name
117 of file IFP and is provided for formatting error-messages only. */
120 bb_read_rec (FILE *ifp
, const char *filename
)
122 unsigned int nblocks
, b
;
123 bfd_vma addr
, ncalls
;
126 if (gmon_io_read_32 (ifp
, &nblocks
))
128 fprintf (stderr
, _("%s: %s: unexpected end of file\n"),
133 nblocks
= bfd_get_32 (core_bfd
, (bfd_byte
*) & nblocks
);
134 if (gmon_file_version
== 0)
137 for (b
= 0; b
< nblocks
; ++b
)
139 if (gmon_file_version
== 0)
143 /* Version 0 had lots of extra stuff that we don't
144 care about anymore. */
145 if ((fread (&ncalls
, sizeof (ncalls
), 1, ifp
) != 1)
146 || (fread (&addr
, sizeof (addr
), 1, ifp
) != 1)
147 || (fskip_string (ifp
), false)
148 || (fskip_string (ifp
), false)
149 || (fread (&line_num
, sizeof (line_num
), 1, ifp
) != 1))
155 else if (gmon_io_read_vma (ifp
, &addr
)
156 || gmon_io_read_vma (ifp
, &ncalls
))
162 /* Basic-block execution counts are meaningful only if we're
163 profiling at the line-by-line level: */
164 if (line_granularity
)
166 sym
= sym_lookup (&symtab
, addr
);
173 printf ("[bb_read_rec] 0x%lx->0x%lx (%s:%d) cnt=%lu\n",
174 (unsigned long) addr
, (unsigned long) sym
->addr
,
175 sym
->name
, sym
->line_num
, (unsigned long) ncalls
));
177 for (i
= 0; i
< NBBS
; i
++)
179 if (! sym
->bb_addr
[i
] || sym
->bb_addr
[i
] == addr
)
181 sym
->bb_addr
[i
] = addr
;
182 sym
->bb_calls
[i
] += ncalls
;
190 static bool user_warned
= false;
196 _("%s: warning: ignoring basic-block exec counts (use -l or --line)\n"),
204 /* Write all basic-blocks with non-zero counts to file OFP. FILENAME
205 is the name of OFP and is provided for producing error-messages
208 bb_write_blocks (FILE *ofp
, const char *filename
)
210 unsigned int nblocks
= 0;
214 /* Count how many non-zero blocks with have: */
215 for (sym
= symtab
.base
; sym
< symtab
.limit
; ++sym
)
217 for (i
= 0; i
< NBBS
&& sym
->bb_addr
[i
]; i
++)
223 if (gmon_io_write_8 (ofp
, GMON_TAG_BB_COUNT
)
224 || gmon_io_write_32 (ofp
, nblocks
))
231 for (sym
= symtab
.base
; sym
< symtab
.limit
; ++sym
)
233 for (i
= 0; i
< NBBS
&& sym
->bb_addr
[i
]; i
++)
235 if (gmon_io_write_vma (ofp
, sym
->bb_addr
[i
])
236 || gmon_io_write_vma (ofp
, (bfd_vma
) sym
->bb_calls
[i
]))
245 /* Output basic-block statistics in a format that is easily parseable.
246 Current the format is:
248 <filename>:<line-number>: (<function-name>:<bb-addr): <ncalls> */
251 print_exec_counts (void)
253 Sym
**sorted_bbs
, *sym
;
254 unsigned int i
, j
, len
;
257 first_output
= false;
261 /* Sort basic-blocks according to function name and line number: */
262 sorted_bbs
= (Sym
**) xmalloc (symtab
.len
* sizeof (sorted_bbs
[0]));
265 for (sym
= symtab
.base
; sym
< symtab
.limit
; ++sym
)
267 /* Accept symbol if it's in the INCL_EXEC table
268 or there is no INCL_EXEC table
269 and it does not appear in the EXCL_EXEC table. */
270 if (sym_lookup (&syms
[INCL_EXEC
], sym
->addr
)
271 || (syms
[INCL_EXEC
].len
== 0
272 && !sym_lookup (&syms
[EXCL_EXEC
], sym
->addr
)))
274 sorted_bbs
[len
++] = sym
;
278 qsort (sorted_bbs
, len
, sizeof (sorted_bbs
[0]), cmp_bb
);
280 /* Output basic-blocks: */
282 for (i
= 0; i
< len
; ++i
)
284 sym
= sorted_bbs
[i
];
286 if (sym
->ncalls
> 0 || ! ignore_zeros
)
288 /* FIXME: This only works if bfd_vma is unsigned long. */
289 printf (_("%s:%d: (%s:0x%lx) %lu executions\n"),
290 sym
->file
? sym
->file
->name
: _("<unknown>"), sym
->line_num
,
291 sym
->name
, (unsigned long) sym
->addr
, sym
->ncalls
);
294 for (j
= 0; j
< NBBS
&& sym
->bb_addr
[j
]; j
++)
296 if (sym
->bb_calls
[j
] > 0 || ! ignore_zeros
)
298 /* FIXME: This only works if bfd_vma is unsigned long. */
299 printf (_("%s:%d: (%s:0x%lx) %lu executions\n"),
300 sym
->file
? sym
->file
->name
: _("<unknown>"), sym
->line_num
,
301 sym
->name
, (unsigned long) sym
->bb_addr
[j
],
309 /* Helper for bb_annotated_source: format annotation containing
310 number of line executions. Depends on being called on each
311 line of a file in sequential order.
313 Global variable bb_annotate_all_lines enables execution count
314 compression (counts are suppressed if identical to the last one)
315 and prints counts on all executed lines. Otherwise, print
316 all basic-block execution counts exactly once on the line
317 that starts the basic-block. */
320 annotate_with_count (char *buf
, unsigned int width
, int line_num
, void *arg
)
322 Source_File
*sf
= (Source_File
*) arg
;
325 static unsigned long last_count
;
326 unsigned long last_print
= (unsigned long) -1;
330 if (line_num
<= sf
->num_lines
)
331 b
= (Sym
*) sf
->line
[line_num
- 1];
335 for (i
= 0; i
< width
; i
++)
341 char tmpbuf
[NBBS
* 30];
343 unsigned long ncalls
;
347 ++num_executable_lines
;
355 /* If this is a function entry point, label the line no matter what.
356 Otherwise, we're in the middle of a function, so check to see
357 if the first basic-block address is larger than the starting
358 address of the line. If so, then this line begins with a
359 a portion of the previous basic-block, so print that prior
360 execution count (if bb_annotate_all_lines is set). */
363 sprintf (p
, "%lu", b
->ncalls
);
365 last_count
= b
->ncalls
;
366 last_print
= last_count
;
370 else if (bb_annotate_all_lines
371 && b
->bb_addr
[0] && b
->bb_addr
[0] > b
->addr
)
373 sprintf (p
, "%lu", last_count
);
375 last_print
= last_count
;
380 /* Loop through all of this line's basic-blocks. For each one,
381 update last_count, then compress sequential identical counts
382 (if bb_annotate_all_lines) and print the execution count. */
384 for (i
= 0; i
< NBBS
&& b
->bb_addr
[i
]; i
++)
386 last_count
= b
->bb_calls
[i
];
392 ncalls
+= last_count
;
394 if (bb_annotate_all_lines
&& last_count
== last_print
)
399 sprintf (p
, "%lu", last_count
);
402 last_print
= last_count
;
405 /* We're done. If nothing has been printed on this line,
406 print the last execution count (bb_annotate_all_lines),
407 which could be from either a previous line (if there were
408 no BBs on this line), or from this line (if all our BB
409 counts were compressed out because they were identical). */
411 if (bb_annotate_all_lines
&& p
== tmpbuf
)
413 sprintf (p
, "%lu", last_count
);
423 for (c
= 0; c
< width
; c
++)
429 ++num_lines_executed
;
431 if (ncalls
< bb_min_calls
)
433 strcpy (tmpbuf
, "#####");
443 strncpy (buf
, tmpbuf
, width
);
450 strcpy (buf
+ width
- len
, tmpbuf
);
451 for (c
= 0; c
< width
- len
; ++c
)
457 /* Annotate the files named in SOURCE_FILES with basic-block statistics
458 (execution counts). After each source files, a few statistics
459 regarding that source file are printed. */
462 print_annotated_source (void)
464 Sym
*sym
, *line_stats
, *new_line
;
469 /* Find maximum line number for each source file that user is
471 for (sym
= symtab
.base
; sym
< symtab
.limit
; ++sym
)
473 /* Accept symbol if it's file is known, its line number is
474 bigger than anything we have seen for that file so far and
475 if it's in the INCL_ANNO table or there is no INCL_ANNO
476 table and it does not appear in the EXCL_ANNO table. */
477 if (sym
->file
&& sym
->line_num
> sym
->file
->num_lines
478 && (sym_lookup (&syms
[INCL_ANNO
], sym
->addr
)
479 || (syms
[INCL_ANNO
].len
== 0
480 && !sym_lookup (&syms
[EXCL_ANNO
], sym
->addr
))))
482 sym
->file
->num_lines
= sym
->line_num
;
486 /* Allocate line descriptors: */
487 for (sf
= first_src_file
; sf
; sf
= sf
->next
)
489 if (sf
->num_lines
> 0)
491 sf
->line
= (void **) xmalloc (sf
->num_lines
* sizeof (sf
->line
[0]));
492 memset (sf
->line
, 0, sf
->num_lines
* sizeof (sf
->line
[0]));
496 /* Count executions per line: */
497 for (sym
= symtab
.base
; sym
< symtab
.limit
; ++sym
)
499 if (sym
->file
&& sym
->file
->num_lines
500 && (sym_lookup (&syms
[INCL_ANNO
], sym
->addr
)
501 || (syms
[INCL_ANNO
].len
== 0
502 && !sym_lookup (&syms
[EXCL_ANNO
], sym
->addr
))))
504 sym
->file
->ncalls
+= sym
->ncalls
;
505 line_stats
= (Sym
*) sym
->file
->line
[sym
->line_num
- 1];
509 /* Common case has at most one basic-block per source line: */
510 sym
->file
->line
[sym
->line_num
- 1] = sym
;
512 else if (!line_stats
->addr
)
514 /* sym is the 3rd .. nth basic block for this line: */
515 line_stats
->ncalls
+= sym
->ncalls
;
519 /* sym is the second basic block for this line. */
520 new_line
= (Sym
*) xmalloc (sizeof (*new_line
));
521 *new_line
= *line_stats
;
523 new_line
->ncalls
+= sym
->ncalls
;
524 sym
->file
->line
[sym
->line_num
- 1] = new_line
;
529 /* Plod over source files, annotating them: */
530 for (sf
= first_src_file
; sf
; sf
= sf
->next
)
532 if (!sf
->num_lines
|| (ignore_zeros
&& sf
->ncalls
== 0))
535 num_executable_lines
= num_lines_executed
= 0;
537 ofp
= annotate_source (sf
, 16, annotate_with_count
, sf
);
541 if (bb_table_length
> 0)
543 fprintf (ofp
, _("\n\nTop %d Lines:\n\n Line Count\n\n"),
546 /* Abuse line arrays---it's not needed anymore: */
547 qsort (sf
->line
, sf
->num_lines
, sizeof (sf
->line
[0]), cmp_ncalls
);
548 table_len
= bb_table_length
;
550 if (table_len
> sf
->num_lines
)
551 table_len
= sf
->num_lines
;
553 for (i
= 0; i
< table_len
; ++i
)
555 sym
= (Sym
*) sf
->line
[i
];
557 if (!sym
|| sym
->ncalls
== 0)
560 fprintf (ofp
, "%9d %10lu\n", sym
->line_num
, sym
->ncalls
);
567 fprintf (ofp
, _("\nExecution Summary:\n\n"));
568 fprintf (ofp
, _("%9ld Executable lines in this file\n"),
569 num_executable_lines
);
570 fprintf (ofp
, _("%9ld Lines executed\n"), num_lines_executed
);
571 fprintf (ofp
, _("%9.2f Percent of the file executed\n"),
573 ? 100.0 * num_lines_executed
/ (double) num_executable_lines
575 fprintf (ofp
, _("\n%9lu Total number of line executions\n"),
577 fprintf (ofp
, _("%9.2f Average executions per line\n"),
579 ? (double) sf
->ncalls
/ (double) num_executable_lines