1 /* Gcov.c: prepend line execution counts and branch probabilities to a
3 Copyright (C) 1990-2021 Free Software Foundation, Inc.
4 Contributed by James E. Wilson of Cygnus Support.
5 Mangled by Bob Manson of Cygnus Support.
6 Mangled further by Nathan Sidwell <nathan@codesourcery.com>
8 Gcov 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, or (at your option)
13 Gcov 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 Gcov; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 /* ??? Print a list of the ten blocks with the highest execution counts,
23 and list the line numbers corresponding to those blocks. Also, perhaps
24 list the line numbers with the highest execution counts, only printing
25 the first if there are several which are all listed in the same block. */
27 /* ??? Should have an option to print the number of basic blocks, and the
28 percent of them that are covered. */
30 /* Need an option to show individual block counts, and show
31 probabilities of fall through arcs. */
34 #define INCLUDE_ALGORITHM
35 #define INCLUDE_VECTOR
36 #define INCLUDE_STRING
40 #include "coretypes.h"
43 #include "diagnostic.h"
46 #include "color-macros.h"
47 #include "pretty-print.h"
61 /* The gcno file is generated by -ftest-coverage option. The gcda file is
62 generated by a program compiled with -fprofile-arcs. Their formats
63 are documented in gcov-io.h. */
65 /* The functions in this file for creating and solution program flow graphs
66 are very similar to functions in the gcc source file profile.c. In
67 some places we make use of the knowledge of how profile.c works to
68 select particular algorithms here. */
70 /* The code validates that the profile information read in corresponds
71 to the code currently being compiled. Rather than checking for
72 identical files, the code below compares a checksum on the CFG
73 (based on the order of basic blocks and the arcs in the CFG). If
74 the CFG checksum in the gcda file match the CFG checksum in the
75 gcno file, the profile data will be used. */
77 /* This is the size of the buffer used to read in source file lines. */
83 /* Describes an arc between two basic blocks. */
87 /* source and destination blocks. */
88 class block_info
*src
;
89 class block_info
*dst
;
91 /* transition counts. */
93 /* used in cycle search, so that we do not clobber original counts. */
96 unsigned int count_valid
: 1;
97 unsigned int on_tree
: 1;
98 unsigned int fake
: 1;
99 unsigned int fall_through
: 1;
101 /* Arc to a catch handler. */
102 unsigned int is_throw
: 1;
104 /* Arc is for a function that abnormally returns. */
105 unsigned int is_call_non_return
: 1;
107 /* Arc is for catch/setjmp. */
108 unsigned int is_nonlocal_return
: 1;
110 /* Is an unconditional branch. */
111 unsigned int is_unconditional
: 1;
113 /* Loop making arc. */
114 unsigned int cycle
: 1;
116 /* Links to next arc on src and dst lists. */
117 struct arc_info
*succ_next
;
118 struct arc_info
*pred_next
;
121 /* Describes which locations (lines and files) are associated with
124 class block_location_info
127 block_location_info (unsigned _source_file_idx
):
128 source_file_idx (_source_file_idx
)
131 unsigned source_file_idx
;
132 vector
<unsigned> lines
;
135 /* Describes a basic block. Contains lists of arcs to successor and
136 predecessor blocks. */
144 /* Chain of exit and entry arcs. */
148 /* Number of unprocessed exit and entry arcs. */
154 /* Block execution count. */
156 unsigned count_valid
: 1;
157 unsigned valid_chain
: 1;
158 unsigned invalid_chain
: 1;
159 unsigned exceptional
: 1;
161 /* Block is a call instrumenting site. */
162 unsigned is_call_site
: 1; /* Does the call. */
163 unsigned is_call_return
: 1; /* Is the return. */
165 /* Block is a landing pad for longjmp or throw. */
166 unsigned is_nonlocal_return
: 1;
168 vector
<block_location_info
> locations
;
172 /* Single line graph cycle workspace. Used for all-blocks
176 } cycle
; /* Used in all-blocks mode, after blocks are linked onto
179 /* Temporary chain for solving graph, and for chaining blocks on one
181 class block_info
*chain
;
185 block_info::block_info (): succ (NULL
), pred (NULL
), num_succ (0), num_pred (0),
186 id (0), count (0), count_valid (0), valid_chain (0), invalid_chain (0),
187 exceptional (0), is_call_site (0), is_call_return (0), is_nonlocal_return (0),
188 locations (), chain (NULL
)
193 /* Describes a single line of source. Contains a chain of basic blocks
199 /* Default constructor. */
202 /* Return true when NEEDLE is one of basic blocks the line belongs to. */
203 bool has_block (block_info
*needle
);
205 /* Execution count. */
208 /* Branches from blocks that end on this line. */
209 vector
<arc_info
*> branches
;
211 /* blocks which start on this line. Used in all-blocks mode. */
212 vector
<block_info
*> blocks
;
215 unsigned unexceptional
: 1;
216 unsigned has_unexecuted_block
: 1;
219 line_info::line_info (): count (0), branches (), blocks (), exists (false),
220 unexceptional (0), has_unexecuted_block (0)
225 line_info::has_block (block_info
*needle
)
227 return std::find (blocks
.begin (), blocks
.end (), needle
) != blocks
.end ();
230 /* Output demangled function names. */
232 static int flag_demangled_names
= 0;
234 /* Describes a single function. Contains an array of basic blocks. */
242 /* Return true when line N belongs to the function in source file SRC_IDX.
243 The line must be defined in body of the function, can't be inlined. */
244 bool group_line_p (unsigned n
, unsigned src_idx
);
246 /* Function filter based on function_info::artificial variable. */
249 is_artificial (function_info
*fn
)
251 return fn
->artificial
;
254 /* Name of function. */
256 char *m_demangled_name
;
258 unsigned lineno_checksum
;
259 unsigned cfg_checksum
;
261 /* The graph contains at least one fake incoming edge. */
262 unsigned has_catch
: 1;
264 /* True when the function is artificial and does not exist
266 unsigned artificial
: 1;
268 /* True when multiple functions start at a line in a source file. */
269 unsigned is_group
: 1;
271 /* Array of basic blocks. Like in GCC, the entry block is
272 at blocks[0] and the exit block is at blocks[1]. */
273 #define ENTRY_BLOCK (0)
274 #define EXIT_BLOCK (1)
275 vector
<block_info
> blocks
;
276 unsigned blocks_executed
;
278 /* Raw arc coverage counts. */
279 vector
<gcov_type
> counts
;
281 /* First line number. */
284 /* First line column. */
285 unsigned start_column
;
287 /* Last line number. */
290 /* Last line column. */
293 /* Index of source file where the function is defined. */
296 /* Vector of line information (used only for group functions). */
297 vector
<line_info
> lines
;
300 class function_info
*next
;
302 /* Get demangled name of a function. The demangled name
303 is converted when it is used for the first time. */
304 char *get_demangled_name ()
306 if (m_demangled_name
== NULL
)
308 m_demangled_name
= cplus_demangle (m_name
, DMGL_PARAMS
);
309 if (!m_demangled_name
)
310 m_demangled_name
= m_name
;
313 return m_demangled_name
;
316 /* Get name of the function based on flag_demangled_names. */
319 return flag_demangled_names
? get_demangled_name () : m_name
;
322 /* Return number of basic blocks (without entry and exit block). */
323 unsigned get_block_count ()
325 return blocks
.size () - 2;
329 /* Function info comparer that will sort functions according to starting
332 struct function_line_start_cmp
334 inline bool operator() (const function_info
*lhs
,
335 const function_info
*rhs
)
337 return (lhs
->start_line
== rhs
->start_line
338 ? lhs
->start_column
< rhs
->start_column
339 : lhs
->start_line
< rhs
->start_line
);
343 /* Describes coverage of a file or function. */
351 int branches_executed
;
360 /* Describes a file mentioned in the block graph. Contains an array
366 /* Default constructor. */
369 vector
<function_info
*> *get_functions_at_location (unsigned line_num
) const;
371 /* Register a new function. */
372 void add_function (function_info
*fn
);
374 /* Debug the source file. */
377 /* Index of the source_info in sources vector. */
380 /* Canonical name of source file. */
384 /* Vector of line information. */
385 vector
<line_info
> lines
;
387 coverage_info coverage
;
389 /* Maximum line count in the source file. */
390 unsigned int maximum_count
;
392 /* Functions in this source file. These are in ascending line
394 vector
<function_info
*> functions
;
396 /* Line number to functions map. */
397 vector
<vector
<function_info
*> *> line_to_function_map
;
400 source_info::source_info (): index (0), name (NULL
), file_time (),
401 lines (), coverage (), maximum_count (0), functions ()
405 /* Register a new function. */
407 source_info::add_function (function_info
*fn
)
409 functions
.push_back (fn
);
411 if (fn
->start_line
>= line_to_function_map
.size ())
412 line_to_function_map
.resize (fn
->start_line
+ 1);
414 vector
<function_info
*> **slot
= &line_to_function_map
[fn
->start_line
];
416 *slot
= new vector
<function_info
*> ();
418 (*slot
)->push_back (fn
);
421 vector
<function_info
*> *
422 source_info::get_functions_at_location (unsigned line_num
) const
424 if (line_num
>= line_to_function_map
.size ())
427 vector
<function_info
*> *slot
= line_to_function_map
[line_num
];
429 std::sort (slot
->begin (), slot
->end (), function_line_start_cmp ());
434 void source_info::debug ()
436 fprintf (stderr
, "source_info: %s\n", name
);
437 for (vector
<function_info
*>::iterator it
= functions
.begin ();
438 it
!= functions
.end (); it
++)
440 function_info
*fn
= *it
;
441 fprintf (stderr
, " function_info: %s\n", fn
->get_name ());
442 for (vector
<block_info
>::iterator bit
= fn
->blocks
.begin ();
443 bit
!= fn
->blocks
.end (); bit
++)
445 fprintf (stderr
, " block_info id=%d, count=%" PRId64
" \n",
446 bit
->id
, bit
->count
);
450 for (unsigned lineno
= 1; lineno
< lines
.size (); ++lineno
)
452 line_info
&line
= lines
[lineno
];
453 fprintf (stderr
, " line_info=%d, count=%" PRId64
"\n", lineno
, line
.count
);
456 fprintf (stderr
, "\n");
466 name_map (char *_name
, unsigned _src
): name (_name
), src (_src
)
470 bool operator== (const name_map
&rhs
) const
472 #if HAVE_DOS_BASED_FILE_SYSTEM
473 return strcasecmp (this->name
, rhs
.name
) == 0;
475 return strcmp (this->name
, rhs
.name
) == 0;
479 bool operator< (const name_map
&rhs
) const
481 #if HAVE_DOS_BASED_FILE_SYSTEM
482 return strcasecmp (this->name
, rhs
.name
) < 0;
484 return strcmp (this->name
, rhs
.name
) < 0;
488 const char *name
; /* Source file name */
489 unsigned src
; /* Source file */
492 /* Vector of all functions. */
493 static vector
<function_info
*> functions
;
495 /* Function ident to function_info * map. */
496 static map
<unsigned, function_info
*> ident_to_fn
;
498 /* Vector of source files. */
499 static vector
<source_info
> sources
;
501 /* Mapping of file names to sources */
502 static vector
<name_map
> names
;
504 /* Record all processed files in order to warn about
505 a file being read multiple times. */
506 static vector
<char *> processed_files
;
508 /* This holds data summary information. */
510 static unsigned object_runs
;
512 static unsigned total_lines
;
513 static unsigned total_executed
;
515 /* Modification time of graph file. */
517 static time_t bbg_file_time
;
519 /* Name of the notes (gcno) output file. The "bbg" prefix is for
520 historical reasons, when the notes file contained only the
521 basic block graph notes. */
523 static char *bbg_file_name
;
525 /* Stamp of the bbg file */
526 static unsigned bbg_stamp
;
528 /* Supports has_unexecuted_blocks functionality. */
529 static unsigned bbg_supports_has_unexecuted_blocks
;
531 /* Working directory in which a TU was compiled. */
532 static const char *bbg_cwd
;
534 /* Name and file pointer of the input file for the count data (gcda). */
536 static char *da_file_name
;
538 /* Data file is missing. */
540 static int no_data_file
;
542 /* If there is several input files, compute and display results after
543 reading all data files. This way if two or more gcda file refer to
544 the same source file (eg inline subprograms in a .h file), the
547 static int multiple_files
= 0;
549 /* Output branch probabilities. */
551 static int flag_branches
= 0;
553 /* Show unconditional branches too. */
554 static int flag_unconditional
= 0;
556 /* Output a gcov file if this is true. This is on by default, and can
557 be turned off by the -n option. */
559 static int flag_gcov_file
= 1;
561 /* Output to stdout instead to a gcov file. */
563 static int flag_use_stdout
= 0;
565 /* Output progress indication if this is true. This is off by default
566 and can be turned on by the -d option. */
568 static int flag_display_progress
= 0;
570 /* Output *.gcov file in JSON intermediate format used by consumers. */
572 static int flag_json_format
= 0;
574 /* For included files, make the gcov output file name include the name
575 of the input source file. For example, if x.h is included in a.c,
576 then the output file name is a.c##x.h.gcov instead of x.h.gcov. */
578 static int flag_long_names
= 0;
580 /* For situations when a long name can potentially hit filesystem path limit,
581 let's calculate md5sum of the path and append it to a file name. */
583 static int flag_hash_filenames
= 0;
585 /* Print verbose informations. */
587 static int flag_verbose
= 0;
589 /* Print colored output. */
591 static int flag_use_colors
= 0;
593 /* Use perf-like colors to indicate hot lines. */
595 static int flag_use_hotness_colors
= 0;
597 /* Output count information for every basic block, not merely those
598 that contain line number information. */
600 static int flag_all_blocks
= 0;
602 /* Output human readable numbers. */
604 static int flag_human_readable_numbers
= 0;
606 /* Output summary info for each function. */
608 static int flag_function_summary
= 0;
610 /* Print debugging dumps. */
612 static int flag_debug
= 0;
614 /* Object directory file prefix. This is the directory/file where the
615 graph and data files are looked for, if nonzero. */
617 static char *object_directory
= 0;
619 /* Source directory prefix. This is removed from source pathnames
620 that match, when generating the output file name. */
622 static char *source_prefix
= 0;
623 static size_t source_length
= 0;
625 /* Only show data for sources with relative pathnames. Absolute ones
626 usually indicate a system header file, which although it may
627 contain inline functions, is usually uninteresting. */
628 static int flag_relative_only
= 0;
630 /* Preserve all pathname components. Needed when object files and
631 source files are in subdirectories. '/' is mangled as '#', '.' is
632 elided and '..' mangled to '^'. */
634 static int flag_preserve_paths
= 0;
636 /* Output the number of times a branch was taken as opposed to the percentage
637 of times it was taken. */
639 static int flag_counts
= 0;
641 /* Forward declarations. */
642 static int process_args (int, char **);
643 static void print_usage (int) ATTRIBUTE_NORETURN
;
644 static void print_version (void) ATTRIBUTE_NORETURN
;
645 static void process_file (const char *);
646 static void process_all_functions (void);
647 static void generate_results (const char *);
648 static void create_file_names (const char *);
649 static char *canonicalize_name (const char *);
650 static unsigned find_source (const char *);
651 static void read_graph_file (void);
652 static int read_count_file (void);
653 static void solve_flow_graph (function_info
*);
654 static void find_exception_blocks (function_info
*);
655 static void add_branch_counts (coverage_info
*, const arc_info
*);
656 static void add_line_counts (coverage_info
*, function_info
*);
657 static void executed_summary (unsigned, unsigned);
658 static void function_summary (const coverage_info
*);
659 static void file_summary (const coverage_info
*);
660 static const char *format_gcov (gcov_type
, gcov_type
, int);
661 static void accumulate_line_counts (source_info
*);
662 static void output_gcov_file (const char *, source_info
*);
663 static int output_branch_count (FILE *, int, const arc_info
*);
664 static void output_lines (FILE *, const source_info
*);
665 static char *make_gcov_file_name (const char *, const char *);
666 static char *mangle_name (const char *, char *);
667 static void release_structures (void);
668 extern int main (int, char **);
670 function_info::function_info (): m_name (NULL
), m_demangled_name (NULL
),
671 ident (0), lineno_checksum (0), cfg_checksum (0), has_catch (0),
672 artificial (0), is_group (0),
673 blocks (), blocks_executed (0), counts (),
674 start_line (0), start_column (0), end_line (0), end_column (0),
675 src (0), lines (), next (NULL
)
679 function_info::~function_info ()
681 for (int i
= blocks
.size () - 1; i
>= 0; i
--)
683 arc_info
*arc
, *arc_n
;
685 for (arc
= blocks
[i
].succ
; arc
; arc
= arc_n
)
687 arc_n
= arc
->succ_next
;
691 if (m_demangled_name
!= m_name
)
692 free (m_demangled_name
);
696 bool function_info::group_line_p (unsigned n
, unsigned src_idx
)
698 return is_group
&& src
== src_idx
&& start_line
<= n
&& n
<= end_line
;
702 There are a bajillion algorithms that do this. Boost's function is named
703 hawick_cycles, so I used the algorithm by K. A. Hawick and H. A. James in
704 "Enumerating Circuits and Loops in Graphs with Self-Arcs and Multiple-Arcs"
705 (url at <http://complexity.massey.ac.nz/cstn/013/cstn-013.pdf>).
707 The basic algorithm is simple: effectively, we're finding all simple paths
708 in a subgraph (that shrinks every iteration). Duplicates are filtered by
709 "blocking" a path when a node is added to the path (this also prevents non-
710 simple paths)--the node is unblocked only when it participates in a cycle.
713 typedef vector
<arc_info
*> arc_vector_t
;
714 typedef vector
<const block_info
*> block_vector_t
;
716 /* Handle cycle identified by EDGES, where the function finds minimum cs_count
717 and subtract the value from all counts. The subtracted value is added
718 to COUNT. Returns type of loop. */
721 handle_cycle (const arc_vector_t
&edges
, int64_t &count
)
723 /* Find the minimum edge of the cycle, and reduce all nodes in the cycle by
725 int64_t cycle_count
= INTTYPE_MAXIMUM (int64_t);
726 for (unsigned i
= 0; i
< edges
.size (); i
++)
728 int64_t ecount
= edges
[i
]->cs_count
;
729 if (cycle_count
> ecount
)
730 cycle_count
= ecount
;
732 count
+= cycle_count
;
733 for (unsigned i
= 0; i
< edges
.size (); i
++)
734 edges
[i
]->cs_count
-= cycle_count
;
736 gcc_assert (cycle_count
> 0);
739 /* Unblock a block U from BLOCKED. Apart from that, iterate all blocks
740 blocked by U in BLOCK_LISTS. */
743 unblock (const block_info
*u
, block_vector_t
&blocked
,
744 vector
<block_vector_t
> &block_lists
)
746 block_vector_t::iterator it
= find (blocked
.begin (), blocked
.end (), u
);
747 if (it
== blocked
.end ())
750 unsigned index
= it
- blocked
.begin ();
753 block_vector_t
to_unblock (block_lists
[index
]);
755 block_lists
.erase (block_lists
.begin () + index
);
757 for (block_vector_t::iterator it
= to_unblock
.begin ();
758 it
!= to_unblock
.end (); it
++)
759 unblock (*it
, blocked
, block_lists
);
762 /* Return true when PATH contains a zero cycle arc count. */
765 path_contains_zero_or_negative_cycle_arc (arc_vector_t
&path
)
767 for (unsigned i
= 0; i
< path
.size (); i
++)
768 if (path
[i
]->cs_count
<= 0)
773 /* Find circuit going to block V, PATH is provisional seen cycle.
774 BLOCKED is vector of blocked vertices, BLOCK_LISTS contains vertices
775 blocked by a block. COUNT is accumulated count of the current LINE.
776 Returns what type of loop it contains. */
779 circuit (block_info
*v
, arc_vector_t
&path
, block_info
*start
,
780 block_vector_t
&blocked
, vector
<block_vector_t
> &block_lists
,
781 line_info
&linfo
, int64_t &count
)
783 bool loop_found
= false;
785 /* Add v to the block list. */
786 gcc_assert (find (blocked
.begin (), blocked
.end (), v
) == blocked
.end ());
787 blocked
.push_back (v
);
788 block_lists
.push_back (block_vector_t ());
790 for (arc_info
*arc
= v
->succ
; arc
; arc
= arc
->succ_next
)
792 block_info
*w
= arc
->dst
;
794 || arc
->cs_count
<= 0
795 || !linfo
.has_block (w
))
798 path
.push_back (arc
);
801 /* Cycle has been found. */
802 handle_cycle (path
, count
);
805 else if (!path_contains_zero_or_negative_cycle_arc (path
)
806 && find (blocked
.begin (), blocked
.end (), w
) == blocked
.end ())
807 loop_found
|= circuit (w
, path
, start
, blocked
, block_lists
, linfo
,
814 unblock (v
, blocked
, block_lists
);
816 for (arc_info
*arc
= v
->succ
; arc
; arc
= arc
->succ_next
)
818 block_info
*w
= arc
->dst
;
820 || arc
->cs_count
<= 0
821 || !linfo
.has_block (w
))
825 = find (blocked
.begin (), blocked
.end (), w
) - blocked
.begin ();
826 gcc_assert (index
< blocked
.size ());
827 block_vector_t
&list
= block_lists
[index
];
828 if (find (list
.begin (), list
.end (), v
) == list
.end ())
835 /* Find cycles for a LINFO. */
838 get_cycles_count (line_info
&linfo
)
840 /* Note that this algorithm works even if blocks aren't in sorted order.
841 Each iteration of the circuit detection is completely independent
842 (except for reducing counts, but that shouldn't matter anyways).
843 Therefore, operating on a permuted order (i.e., non-sorted) only
844 has the effect of permuting the output cycles. */
846 bool loop_found
= false;
848 for (vector
<block_info
*>::iterator it
= linfo
.blocks
.begin ();
849 it
!= linfo
.blocks
.end (); it
++)
852 block_vector_t blocked
;
853 vector
<block_vector_t
> block_lists
;
854 loop_found
|= circuit (*it
, path
, *it
, blocked
, block_lists
, linfo
,
862 main (int argc
, char **argv
)
868 p
= argv
[0] + strlen (argv
[0]);
869 while (p
!= argv
[0] && !IS_DIR_SEPARATOR (p
[-1]))
873 xmalloc_set_program_name (progname
);
875 /* Unlock the stdio streams. */
876 unlock_std_streams ();
880 diagnostic_initialize (global_dc
, 0);
882 /* Handle response files. */
883 expandargv (&argc
, &argv
);
885 argno
= process_args (argc
, argv
);
889 if (argc
- argno
> 1)
894 for (; argno
!= argc
; argno
++)
896 if (flag_display_progress
)
897 printf ("Processing file %d out of %d\n", argno
- first_arg
+ 1,
899 process_file (argv
[argno
]);
901 if (flag_json_format
|| argno
== argc
- 1)
903 process_all_functions ();
904 generate_results (argv
[argno
]);
905 release_structures ();
909 if (!flag_use_stdout
)
910 executed_summary (total_lines
, total_executed
);
915 /* Print a usage message and exit. If ERROR_P is nonzero, this is an error,
916 otherwise the output of --help. */
919 print_usage (int error_p
)
921 FILE *file
= error_p
? stderr
: stdout
;
922 int status
= error_p
? FATAL_EXIT_CODE
: SUCCESS_EXIT_CODE
;
924 fnotice (file
, "Usage: gcov [OPTION...] SOURCE|OBJ...\n\n");
925 fnotice (file
, "Print code coverage information.\n\n");
926 fnotice (file
, " -a, --all-blocks Show information for every basic block\n");
927 fnotice (file
, " -b, --branch-probabilities Include branch probabilities in output\n");
928 fnotice (file
, " -c, --branch-counts Output counts of branches taken\n\
929 rather than percentages\n");
930 fnotice (file
, " -d, --display-progress Display progress information\n");
931 fnotice (file
, " -D, --debug Display debugging dumps\n");
932 fnotice (file
, " -f, --function-summaries Output summaries for each function\n");
933 fnotice (file
, " -h, --help Print this help, then exit\n");
934 fnotice (file
, " -j, --json-format Output JSON intermediate format\n\
935 into .gcov.json.gz file\n");
936 fnotice (file
, " -H, --human-readable Output human readable numbers\n");
937 fnotice (file
, " -k, --use-colors Emit colored output\n");
938 fnotice (file
, " -l, --long-file-names Use long output file names for included\n\
940 fnotice (file
, " -m, --demangled-names Output demangled function names\n");
941 fnotice (file
, " -n, --no-output Do not create an output file\n");
942 fnotice (file
, " -o, --object-directory DIR|FILE Search for object files in DIR or called FILE\n");
943 fnotice (file
, " -p, --preserve-paths Preserve all pathname components\n");
944 fnotice (file
, " -q, --use-hotness-colors Emit perf-like colored output for hot lines\n");
945 fnotice (file
, " -r, --relative-only Only show data for relative sources\n");
946 fnotice (file
, " -s, --source-prefix DIR Source prefix to elide\n");
947 fnotice (file
, " -t, --stdout Output to stdout instead of a file\n");
948 fnotice (file
, " -u, --unconditional-branches Show unconditional branch counts too\n");
949 fnotice (file
, " -v, --version Print version number, then exit\n");
950 fnotice (file
, " -w, --verbose Print verbose informations\n");
951 fnotice (file
, " -x, --hash-filenames Hash long pathnames\n");
952 fnotice (file
, "\nObsolete options:\n");
953 fnotice (file
, " -i, --json-format Replaced with -j, --json-format\n");
954 fnotice (file
, " -j, --human-readable Replaced with -H, --human-readable\n");
955 fnotice (file
, "\nFor bug reporting instructions, please see:\n%s.\n",
960 /* Print version information and exit. */
965 fnotice (stdout
, "gcov %s%s\n", pkgversion_string
, version_string
);
966 fprintf (stdout
, "Copyright %s 2021 Free Software Foundation, Inc.\n",
969 _("This is free software; see the source for copying conditions. There is NO\n\
970 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n"));
971 exit (SUCCESS_EXIT_CODE
);
974 static const struct option options
[] =
976 { "help", no_argument
, NULL
, 'h' },
977 { "version", no_argument
, NULL
, 'v' },
978 { "verbose", no_argument
, NULL
, 'w' },
979 { "all-blocks", no_argument
, NULL
, 'a' },
980 { "branch-probabilities", no_argument
, NULL
, 'b' },
981 { "branch-counts", no_argument
, NULL
, 'c' },
982 { "json-format", no_argument
, NULL
, 'j' },
983 { "human-readable", no_argument
, NULL
, 'H' },
984 { "no-output", no_argument
, NULL
, 'n' },
985 { "long-file-names", no_argument
, NULL
, 'l' },
986 { "function-summaries", no_argument
, NULL
, 'f' },
987 { "demangled-names", no_argument
, NULL
, 'm' },
988 { "preserve-paths", no_argument
, NULL
, 'p' },
989 { "relative-only", no_argument
, NULL
, 'r' },
990 { "object-directory", required_argument
, NULL
, 'o' },
991 { "object-file", required_argument
, NULL
, 'o' },
992 { "source-prefix", required_argument
, NULL
, 's' },
993 { "stdout", no_argument
, NULL
, 't' },
994 { "unconditional-branches", no_argument
, NULL
, 'u' },
995 { "display-progress", no_argument
, NULL
, 'd' },
996 { "hash-filenames", no_argument
, NULL
, 'x' },
997 { "use-colors", no_argument
, NULL
, 'k' },
998 { "use-hotness-colors", no_argument
, NULL
, 'q' },
999 { "debug", no_argument
, NULL
, 'D' },
1003 /* Process args, return index to first non-arg. */
1006 process_args (int argc
, char **argv
)
1010 const char *opts
= "abcdDfhHijklmno:pqrs:tuvwx";
1011 while ((opt
= getopt_long (argc
, argv
, opts
, options
, NULL
)) != -1)
1016 flag_all_blocks
= 1;
1025 flag_function_summary
= 1;
1028 print_usage (false);
1029 /* print_usage will exit. */
1031 flag_long_names
= 1;
1034 flag_human_readable_numbers
= 1;
1037 flag_use_colors
= 1;
1040 flag_use_hotness_colors
= 1;
1043 flag_demangled_names
= 1;
1049 object_directory
= optarg
;
1052 source_prefix
= optarg
;
1053 source_length
= strlen (source_prefix
);
1056 flag_relative_only
= 1;
1059 flag_preserve_paths
= 1;
1062 flag_unconditional
= 1;
1066 flag_json_format
= 1;
1070 flag_display_progress
= 1;
1073 flag_hash_filenames
= 1;
1079 flag_use_stdout
= 1;
1086 /* print_version will exit. */
1089 /* print_usage will exit. */
1096 /* Output intermediate LINE sitting on LINE_NUM to JSON OBJECT.
1097 Add FUNCTION_NAME to the LINE. */
1100 output_intermediate_json_line (json::array
*object
,
1101 line_info
*line
, unsigned line_num
,
1102 const char *function_name
)
1107 json::object
*lineo
= new json::object ();
1108 lineo
->set ("line_number", new json::integer_number (line_num
));
1109 if (function_name
!= NULL
)
1110 lineo
->set ("function_name", new json::string (function_name
));
1111 lineo
->set ("count", new json::integer_number (line
->count
));
1112 lineo
->set ("unexecuted_block",
1113 new json::literal (line
->has_unexecuted_block
));
1115 json::array
*branches
= new json::array ();
1116 lineo
->set ("branches", branches
);
1118 vector
<arc_info
*>::const_iterator it
;
1120 for (it
= line
->branches
.begin (); it
!= line
->branches
.end ();
1123 if (!(*it
)->is_unconditional
&& !(*it
)->is_call_non_return
)
1125 json::object
*branch
= new json::object ();
1126 branch
->set ("count", new json::integer_number ((*it
)->count
));
1127 branch
->set ("throw", new json::literal ((*it
)->is_throw
));
1128 branch
->set ("fallthrough",
1129 new json::literal ((*it
)->fall_through
));
1130 branches
->append (branch
);
1134 object
->append (lineo
);
1137 /* Get the name of the gcov file. The return value must be free'd.
1139 It appends the '.gcov' extension to the *basename* of the file.
1140 The resulting file name will be in PWD.
1143 input: foo.da, output: foo.da.gcov
1144 input: a/b/foo.cc, output: foo.cc.gcov */
1147 get_gcov_intermediate_filename (const char *file_name
)
1149 const char *gcov
= ".gcov.json.gz";
1153 /* Find the 'basename'. */
1154 cptr
= lbasename (file_name
);
1156 result
= XNEWVEC (char, strlen (cptr
) + strlen (gcov
) + 1);
1157 sprintf (result
, "%s%s", cptr
, gcov
);
1162 /* Output the result in JSON intermediate format.
1163 Source info SRC is dumped into JSON_FILES which is JSON array. */
1166 output_json_intermediate_file (json::array
*json_files
, source_info
*src
)
1168 json::object
*root
= new json::object ();
1169 json_files
->append (root
);
1171 root
->set ("file", new json::string (src
->name
));
1173 json::array
*functions
= new json::array ();
1174 root
->set ("functions", functions
);
1176 std::sort (src
->functions
.begin (), src
->functions
.end (),
1177 function_line_start_cmp ());
1178 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
1179 it
!= src
->functions
.end (); it
++)
1181 json::object
*function
= new json::object ();
1182 function
->set ("name", new json::string ((*it
)->m_name
));
1183 function
->set ("demangled_name",
1184 new json::string ((*it
)->get_demangled_name ()));
1185 function
->set ("start_line",
1186 new json::integer_number ((*it
)->start_line
));
1187 function
->set ("start_column",
1188 new json::integer_number ((*it
)->start_column
));
1189 function
->set ("end_line", new json::integer_number ((*it
)->end_line
));
1190 function
->set ("end_column",
1191 new json::integer_number ((*it
)->end_column
));
1192 function
->set ("blocks",
1193 new json::integer_number ((*it
)->get_block_count ()));
1194 function
->set ("blocks_executed",
1195 new json::integer_number ((*it
)->blocks_executed
));
1196 function
->set ("execution_count",
1197 new json::integer_number ((*it
)->blocks
[0].count
));
1199 functions
->append (function
);
1202 json::array
*lineso
= new json::array ();
1203 root
->set ("lines", lineso
);
1205 vector
<function_info
*> last_non_group_fns
;
1207 for (unsigned line_num
= 1; line_num
<= src
->lines
.size (); line_num
++)
1209 vector
<function_info
*> *fns
= src
->get_functions_at_location (line_num
);
1212 /* Print info for all group functions that begin on the line. */
1213 for (vector
<function_info
*>::iterator it2
= fns
->begin ();
1214 it2
!= fns
->end (); it2
++)
1216 if (!(*it2
)->is_group
)
1217 last_non_group_fns
.push_back (*it2
);
1219 vector
<line_info
> &lines
= (*it2
)->lines
;
1220 /* The LINES array is allocated only for group functions. */
1221 for (unsigned i
= 0; i
< lines
.size (); i
++)
1223 line_info
*line
= &lines
[i
];
1224 output_intermediate_json_line (lineso
, line
, line_num
+ i
,
1229 /* Follow with lines associated with the source file. */
1230 if (line_num
< src
->lines
.size ())
1232 unsigned size
= last_non_group_fns
.size ();
1233 function_info
*last_fn
= size
> 0 ? last_non_group_fns
[size
- 1] : NULL
;
1234 const char *fname
= last_fn
? last_fn
->m_name
: NULL
;
1235 output_intermediate_json_line (lineso
, &src
->lines
[line_num
], line_num
,
1238 /* Pop ending function from stack. */
1239 if (last_fn
!= NULL
&& last_fn
->end_line
== line_num
)
1240 last_non_group_fns
.pop_back ();
1245 /* Function start pair. */
1246 struct function_start
1248 unsigned source_file_idx
;
1249 unsigned start_line
;
1252 /* Traits class for function start hash maps below. */
1254 struct function_start_pair_hash
: typed_noop_remove
<function_start
>
1256 typedef function_start value_type
;
1257 typedef function_start compare_type
;
1260 hash (const function_start
&ref
)
1262 inchash::hash
hstate (0);
1263 hstate
.add_int (ref
.source_file_idx
);
1264 hstate
.add_int (ref
.start_line
);
1265 return hstate
.end ();
1269 equal (const function_start
&ref1
, const function_start
&ref2
)
1271 return (ref1
.source_file_idx
== ref2
.source_file_idx
1272 && ref1
.start_line
== ref2
.start_line
);
1276 mark_deleted (function_start
&ref
)
1278 ref
.start_line
= ~1U;
1281 static const bool empty_zero_p
= false;
1284 mark_empty (function_start
&ref
)
1286 ref
.start_line
= ~2U;
1290 is_deleted (const function_start
&ref
)
1292 return ref
.start_line
== ~1U;
1296 is_empty (const function_start
&ref
)
1298 return ref
.start_line
== ~2U;
1302 /* Process a single input file. */
1305 process_file (const char *file_name
)
1307 create_file_names (file_name
);
1309 for (unsigned i
= 0; i
< processed_files
.size (); i
++)
1310 if (strcmp (da_file_name
, processed_files
[i
]) == 0)
1312 fnotice (stderr
, "'%s' file is already processed\n",
1317 processed_files
.push_back (xstrdup (da_file_name
));
1323 /* Process all functions in all files. */
1326 process_all_functions (void)
1328 hash_map
<function_start_pair_hash
, function_info
*> fn_map
;
1330 /* Identify group functions. */
1331 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1332 it
!= functions
.end (); it
++)
1333 if (!(*it
)->artificial
)
1335 function_start needle
;
1336 needle
.source_file_idx
= (*it
)->src
;
1337 needle
.start_line
= (*it
)->start_line
;
1339 function_info
**slot
= fn_map
.get (needle
);
1342 (*slot
)->is_group
= 1;
1343 (*it
)->is_group
= 1;
1346 fn_map
.put (needle
, *it
);
1349 /* Remove all artificial function. */
1350 functions
.erase (remove_if (functions
.begin (), functions
.end (),
1351 function_info::is_artificial
), functions
.end ());
1353 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1354 it
!= functions
.end (); it
++)
1356 function_info
*fn
= *it
;
1357 unsigned src
= fn
->src
;
1359 if (!fn
->counts
.empty () || no_data_file
)
1361 source_info
*s
= &sources
[src
];
1362 s
->add_function (fn
);
1364 /* Mark last line in files touched by function. */
1365 for (unsigned block_no
= 0; block_no
!= fn
->blocks
.size ();
1368 block_info
*block
= &fn
->blocks
[block_no
];
1369 for (unsigned i
= 0; i
< block
->locations
.size (); i
++)
1371 /* Sort lines of locations. */
1372 sort (block
->locations
[i
].lines
.begin (),
1373 block
->locations
[i
].lines
.end ());
1375 if (!block
->locations
[i
].lines
.empty ())
1377 s
= &sources
[block
->locations
[i
].source_file_idx
];
1379 = block
->locations
[i
].lines
.back ();
1381 /* Record new lines for the function. */
1382 if (last_line
>= s
->lines
.size ())
1384 s
= &sources
[block
->locations
[i
].source_file_idx
];
1386 = block
->locations
[i
].lines
.back ();
1388 /* Record new lines for the function. */
1389 if (last_line
>= s
->lines
.size ())
1391 /* Record new lines for a source file. */
1392 s
->lines
.resize (last_line
+ 1);
1399 /* Allocate lines for group function, following start_line
1400 and end_line information of the function. */
1402 fn
->lines
.resize (fn
->end_line
- fn
->start_line
+ 1);
1404 solve_flow_graph (fn
);
1406 find_exception_blocks (fn
);
1410 /* The function was not in the executable -- some other
1411 instance must have been selected. */
1417 output_gcov_file (const char *file_name
, source_info
*src
)
1419 char *gcov_file_name
= make_gcov_file_name (file_name
, src
->coverage
.name
);
1421 if (src
->coverage
.lines
)
1423 FILE *gcov_file
= fopen (gcov_file_name
, "w");
1426 fnotice (stdout
, "Creating '%s'\n", gcov_file_name
);
1427 output_lines (gcov_file
, src
);
1428 if (ferror (gcov_file
))
1429 fnotice (stderr
, "Error writing output file '%s'\n",
1434 fnotice (stderr
, "Could not open output file '%s'\n", gcov_file_name
);
1438 unlink (gcov_file_name
);
1439 fnotice (stdout
, "Removing '%s'\n", gcov_file_name
);
1441 free (gcov_file_name
);
1445 generate_results (const char *file_name
)
1447 char *gcov_intermediate_filename
;
1449 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1450 it
!= functions
.end (); it
++)
1452 function_info
*fn
= *it
;
1453 coverage_info coverage
;
1455 memset (&coverage
, 0, sizeof (coverage
));
1456 coverage
.name
= fn
->get_name ();
1457 add_line_counts (flag_function_summary
? &coverage
: NULL
, fn
);
1458 if (flag_function_summary
)
1460 function_summary (&coverage
);
1461 fnotice (stdout
, "\n");
1466 needle
.name
= file_name
;
1467 vector
<name_map
>::iterator it
1468 = std::find (names
.begin (), names
.end (), needle
);
1469 if (it
!= names
.end ())
1470 file_name
= sources
[it
->src
].coverage
.name
;
1472 file_name
= canonicalize_name (file_name
);
1474 gcov_intermediate_filename
= get_gcov_intermediate_filename (file_name
);
1476 json::object
*root
= new json::object ();
1477 root
->set ("format_version", new json::string ("1"));
1478 root
->set ("gcc_version", new json::string (version_string
));
1480 if (bbg_cwd
!= NULL
)
1481 root
->set ("current_working_directory", new json::string (bbg_cwd
));
1482 root
->set ("data_file", new json::string (file_name
));
1484 json::array
*json_files
= new json::array ();
1485 root
->set ("files", json_files
);
1487 for (vector
<source_info
>::iterator it
= sources
.begin ();
1488 it
!= sources
.end (); it
++)
1490 source_info
*src
= &(*it
);
1491 if (flag_relative_only
)
1493 /* Ignore this source, if it is an absolute path (after
1494 source prefix removal). */
1495 char first
= src
->coverage
.name
[0];
1497 #if HAVE_DOS_BASED_FILE_SYSTEM
1498 if (first
&& src
->coverage
.name
[1] == ':')
1499 first
= src
->coverage
.name
[2];
1501 if (IS_DIR_SEPARATOR (first
))
1505 accumulate_line_counts (src
);
1509 if (!flag_use_stdout
)
1510 file_summary (&src
->coverage
);
1511 total_lines
+= src
->coverage
.lines
;
1512 total_executed
+= src
->coverage
.lines_executed
;
1515 if (flag_json_format
)
1517 output_json_intermediate_file (json_files
, src
);
1518 if (!flag_use_stdout
)
1519 fnotice (stdout
, "\n");
1523 if (flag_use_stdout
)
1525 if (src
->coverage
.lines
)
1526 output_lines (stdout
, src
);
1530 output_gcov_file (file_name
, src
);
1531 fnotice (stdout
, "\n");
1537 if (flag_gcov_file
&& flag_json_format
)
1539 if (flag_use_stdout
)
1541 root
->dump (stdout
);
1548 pp_formatted_text (&pp
);
1550 gzFile output
= gzopen (gcov_intermediate_filename
, "w");
1553 fnotice (stderr
, "Cannot open JSON output file %s\n",
1554 gcov_intermediate_filename
);
1558 if (gzputs (output
, pp_formatted_text (&pp
)) == EOF
1559 || gzclose (output
))
1561 fnotice (stderr
, "Error writing JSON output file %s\n",
1562 gcov_intermediate_filename
);
1569 /* Release all memory used. */
1572 release_structures (void)
1574 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1575 it
!= functions
.end (); it
++)
1580 functions
.resize (0);
1581 ident_to_fn
.clear ();
1584 /* Generate the names of the graph and data files. If OBJECT_DIRECTORY
1585 is not specified, these are named from FILE_NAME sans extension. If
1586 OBJECT_DIRECTORY is specified and is a directory, the files are in that
1587 directory, but named from the basename of the FILE_NAME, sans extension.
1588 Otherwise OBJECT_DIRECTORY is taken to be the name of the object *file*
1589 and the data files are named from that. */
1592 create_file_names (const char *file_name
)
1596 int length
= strlen (file_name
);
1599 /* Free previous file names. */
1600 free (bbg_file_name
);
1601 free (da_file_name
);
1602 da_file_name
= bbg_file_name
= NULL
;
1606 if (object_directory
&& object_directory
[0])
1610 length
+= strlen (object_directory
) + 2;
1611 name
= XNEWVEC (char, length
);
1614 base
= !stat (object_directory
, &status
) && S_ISDIR (status
.st_mode
);
1615 strcat (name
, object_directory
);
1616 if (base
&& (!IS_DIR_SEPARATOR (name
[strlen (name
) - 1])))
1621 name
= XNEWVEC (char, length
+ 1);
1622 strcpy (name
, file_name
);
1628 /* Append source file name. */
1629 const char *cptr
= lbasename (file_name
);
1630 strcat (name
, cptr
? cptr
: file_name
);
1633 /* Remove the extension. */
1634 cptr
= strrchr (CONST_CAST (char *, lbasename (name
)), '.');
1638 length
= strlen (name
);
1640 bbg_file_name
= XNEWVEC (char, length
+ strlen (GCOV_NOTE_SUFFIX
) + 1);
1641 strcpy (bbg_file_name
, name
);
1642 strcpy (bbg_file_name
+ length
, GCOV_NOTE_SUFFIX
);
1644 da_file_name
= XNEWVEC (char, length
+ strlen (GCOV_DATA_SUFFIX
) + 1);
1645 strcpy (da_file_name
, name
);
1646 strcpy (da_file_name
+ length
, GCOV_DATA_SUFFIX
);
1652 /* Find or create a source file structure for FILE_NAME. Copies
1653 FILE_NAME on creation */
1656 find_source (const char *file_name
)
1663 file_name
= "<unknown>";
1666 needle
.name
= file_name
;
1668 vector
<name_map
>::iterator it
= std::find (names
.begin (), names
.end (),
1670 if (it
!= names
.end ())
1676 /* Not found, try the canonical name. */
1677 canon
= canonicalize_name (file_name
);
1678 needle
.name
= canon
;
1679 it
= std::find (names
.begin (), names
.end (), needle
);
1680 if (it
== names
.end ())
1682 /* Not found with canonical name, create a new source. */
1685 idx
= sources
.size ();
1686 needle
= name_map (canon
, idx
);
1687 names
.push_back (needle
);
1689 sources
.push_back (source_info ());
1690 src
= &sources
.back ();
1692 src
->coverage
.name
= src
->name
;
1695 #if HAVE_DOS_BASED_FILE_SYSTEM
1696 /* You lose if separators don't match exactly in the
1698 && !strncasecmp (source_prefix
, src
->coverage
.name
, source_length
)
1700 && !strncmp (source_prefix
, src
->coverage
.name
, source_length
)
1702 && IS_DIR_SEPARATOR (src
->coverage
.name
[source_length
]))
1703 src
->coverage
.name
+= source_length
+ 1;
1704 if (!stat (src
->name
, &status
))
1705 src
->file_time
= status
.st_mtime
;
1710 needle
.name
= file_name
;
1711 if (std::find (names
.begin (), names
.end (), needle
) == names
.end ())
1713 /* Append the non-canonical name. */
1714 names
.push_back (name_map (xstrdup (file_name
), idx
));
1717 /* Resort the name map. */
1718 std::sort (names
.begin (), names
.end ());
1721 if (sources
[idx
].file_time
> bbg_file_time
)
1723 static int info_emitted
;
1725 fnotice (stderr
, "%s:source file is newer than notes file '%s'\n",
1726 file_name
, bbg_file_name
);
1730 "(the message is displayed only once per source file)\n");
1733 sources
[idx
].file_time
= 0;
1739 /* Read the notes file. Save functions to FUNCTIONS global vector. */
1742 read_graph_file (void)
1745 unsigned current_tag
= 0;
1748 if (!gcov_open (bbg_file_name
, 1))
1750 fnotice (stderr
, "%s:cannot open notes file\n", bbg_file_name
);
1753 bbg_file_time
= gcov_time ();
1754 if (!gcov_magic (gcov_read_unsigned (), GCOV_NOTE_MAGIC
))
1756 fnotice (stderr
, "%s:not a gcov notes file\n", bbg_file_name
);
1761 version
= gcov_read_unsigned ();
1762 if (version
!= GCOV_VERSION
)
1766 GCOV_UNSIGNED2STRING (v
, version
);
1767 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
1769 fnotice (stderr
, "%s:version '%.4s', prefer '%.4s'\n",
1770 bbg_file_name
, v
, e
);
1772 bbg_stamp
= gcov_read_unsigned ();
1773 bbg_cwd
= xstrdup (gcov_read_string ());
1774 bbg_supports_has_unexecuted_blocks
= gcov_read_unsigned ();
1776 function_info
*fn
= NULL
;
1777 while ((tag
= gcov_read_unsigned ()))
1779 unsigned length
= gcov_read_unsigned ();
1780 gcov_position_t base
= gcov_position ();
1782 if (tag
== GCOV_TAG_FUNCTION
)
1784 char *function_name
;
1786 unsigned lineno_checksum
, cfg_checksum
;
1788 ident
= gcov_read_unsigned ();
1789 lineno_checksum
= gcov_read_unsigned ();
1790 cfg_checksum
= gcov_read_unsigned ();
1791 function_name
= xstrdup (gcov_read_string ());
1792 unsigned artificial
= gcov_read_unsigned ();
1793 unsigned src_idx
= find_source (gcov_read_string ());
1794 unsigned start_line
= gcov_read_unsigned ();
1795 unsigned start_column
= gcov_read_unsigned ();
1796 unsigned end_line
= gcov_read_unsigned ();
1797 unsigned end_column
= gcov_read_unsigned ();
1799 fn
= new function_info ();
1800 functions
.push_back (fn
);
1801 ident_to_fn
[ident
] = fn
;
1803 fn
->m_name
= function_name
;
1805 fn
->lineno_checksum
= lineno_checksum
;
1806 fn
->cfg_checksum
= cfg_checksum
;
1808 fn
->start_line
= start_line
;
1809 fn
->start_column
= start_column
;
1810 fn
->end_line
= end_line
;
1811 fn
->end_column
= end_column
;
1812 fn
->artificial
= artificial
;
1816 else if (fn
&& tag
== GCOV_TAG_BLOCKS
)
1818 if (!fn
->blocks
.empty ())
1819 fnotice (stderr
, "%s:already seen blocks for '%s'\n",
1820 bbg_file_name
, fn
->get_name ());
1822 fn
->blocks
.resize (gcov_read_unsigned ());
1824 else if (fn
&& tag
== GCOV_TAG_ARCS
)
1826 unsigned src
= gcov_read_unsigned ();
1827 fn
->blocks
[src
].id
= src
;
1828 unsigned num_dests
= GCOV_TAG_ARCS_NUM (length
);
1829 block_info
*src_blk
= &fn
->blocks
[src
];
1830 unsigned mark_catches
= 0;
1831 struct arc_info
*arc
;
1833 if (src
>= fn
->blocks
.size () || fn
->blocks
[src
].succ
)
1838 unsigned dest
= gcov_read_unsigned ();
1839 unsigned flags
= gcov_read_unsigned ();
1841 if (dest
>= fn
->blocks
.size ())
1843 arc
= XCNEW (arc_info
);
1845 arc
->dst
= &fn
->blocks
[dest
];
1846 /* Set id in order to find EXIT_BLOCK. */
1847 arc
->dst
->id
= dest
;
1851 arc
->count_valid
= 0;
1852 arc
->on_tree
= !!(flags
& GCOV_ARC_ON_TREE
);
1853 arc
->fake
= !!(flags
& GCOV_ARC_FAKE
);
1854 arc
->fall_through
= !!(flags
& GCOV_ARC_FALLTHROUGH
);
1856 arc
->succ_next
= src_blk
->succ
;
1857 src_blk
->succ
= arc
;
1858 src_blk
->num_succ
++;
1860 arc
->pred_next
= fn
->blocks
[dest
].pred
;
1861 fn
->blocks
[dest
].pred
= arc
;
1862 fn
->blocks
[dest
].num_pred
++;
1868 /* Exceptional exit from this function, the
1869 source block must be a call. */
1870 fn
->blocks
[src
].is_call_site
= 1;
1871 arc
->is_call_non_return
= 1;
1876 /* Non-local return from a callee of this
1877 function. The destination block is a setjmp. */
1878 arc
->is_nonlocal_return
= 1;
1879 fn
->blocks
[dest
].is_nonlocal_return
= 1;
1884 fn
->counts
.push_back (0);
1889 /* We have a fake exit from this block. The other
1890 non-fall through exits must be to catch handlers.
1891 Mark them as catch arcs. */
1893 for (arc
= src_blk
->succ
; arc
; arc
= arc
->succ_next
)
1894 if (!arc
->fake
&& !arc
->fall_through
)
1901 else if (fn
&& tag
== GCOV_TAG_LINES
)
1903 unsigned blockno
= gcov_read_unsigned ();
1904 block_info
*block
= &fn
->blocks
[blockno
];
1906 if (blockno
>= fn
->blocks
.size ())
1911 unsigned lineno
= gcov_read_unsigned ();
1914 block
->locations
.back ().lines
.push_back (lineno
);
1917 const char *file_name
= gcov_read_string ();
1921 block
->locations
.push_back (block_location_info
1922 (find_source (file_name
)));
1926 else if (current_tag
&& !GCOV_TAG_IS_SUBTAG (current_tag
, tag
))
1931 gcov_sync (base
, length
);
1932 if (gcov_is_error ())
1935 fnotice (stderr
, "%s:corrupted\n", bbg_file_name
);
1941 if (functions
.empty ())
1942 fnotice (stderr
, "%s:no functions found\n", bbg_file_name
);
1945 /* Reads profiles from the count file and attach to each
1946 function. Return nonzero if fatal error. */
1949 read_count_file (void)
1954 function_info
*fn
= NULL
;
1956 map
<unsigned, function_info
*>::iterator it
;
1958 if (!gcov_open (da_file_name
, 1))
1960 fnotice (stderr
, "%s:cannot open data file, assuming not executed\n",
1965 if (!gcov_magic (gcov_read_unsigned (), GCOV_DATA_MAGIC
))
1967 fnotice (stderr
, "%s:not a gcov data file\n", da_file_name
);
1972 version
= gcov_read_unsigned ();
1973 if (version
!= GCOV_VERSION
)
1977 GCOV_UNSIGNED2STRING (v
, version
);
1978 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
1980 fnotice (stderr
, "%s:version '%.4s', prefer version '%.4s'\n",
1981 da_file_name
, v
, e
);
1983 tag
= gcov_read_unsigned ();
1984 if (tag
!= bbg_stamp
)
1986 fnotice (stderr
, "%s:stamp mismatch with notes file\n", da_file_name
);
1990 while ((tag
= gcov_read_unsigned ()))
1992 unsigned length
= gcov_read_unsigned ();
1993 int read_length
= (int)length
;
1994 unsigned long base
= gcov_position ();
1996 if (tag
== GCOV_TAG_OBJECT_SUMMARY
)
1998 struct gcov_summary summary
;
1999 gcov_read_summary (&summary
);
2000 object_runs
= summary
.runs
;
2002 else if (tag
== GCOV_TAG_FUNCTION
&& !length
)
2004 else if (tag
== GCOV_TAG_FUNCTION
&& length
== GCOV_TAG_FUNCTION_LENGTH
)
2007 ident
= gcov_read_unsigned ();
2009 it
= ident_to_fn
.find (ident
);
2010 if (it
!= ident_to_fn
.end ())
2015 else if (gcov_read_unsigned () != fn
->lineno_checksum
2016 || gcov_read_unsigned () != fn
->cfg_checksum
)
2019 fnotice (stderr
, "%s:profile mismatch for '%s'\n",
2020 da_file_name
, fn
->get_name ());
2024 else if (tag
== GCOV_TAG_FOR_COUNTER (GCOV_COUNTER_ARCS
) && fn
)
2026 length
= abs (read_length
);
2027 if (length
!= GCOV_TAG_COUNTER_LENGTH (fn
->counts
.size ()))
2030 if (read_length
> 0)
2031 for (ix
= 0; ix
!= fn
->counts
.size (); ix
++)
2032 fn
->counts
[ix
] += gcov_read_counter ();
2034 if (read_length
< 0)
2036 gcov_sync (base
, read_length
);
2037 if ((error
= gcov_is_error ()))
2041 ? N_("%s:overflowed\n")
2042 : N_("%s:corrupted\n"),
2052 /* Solve the flow graph. Propagate counts from the instrumented arcs
2053 to the blocks and the uninstrumented arcs. */
2056 solve_flow_graph (function_info
*fn
)
2060 gcov_type
*count_ptr
= &fn
->counts
.front ();
2062 block_info
*valid_blocks
= NULL
; /* valid, but unpropagated blocks. */
2063 block_info
*invalid_blocks
= NULL
; /* invalid, but inferable blocks. */
2065 /* The arcs were built in reverse order. Fix that now. */
2066 for (ix
= fn
->blocks
.size (); ix
--;)
2068 arc_info
*arc_p
, *arc_n
;
2070 for (arc_p
= NULL
, arc
= fn
->blocks
[ix
].succ
; arc
;
2071 arc_p
= arc
, arc
= arc_n
)
2073 arc_n
= arc
->succ_next
;
2074 arc
->succ_next
= arc_p
;
2076 fn
->blocks
[ix
].succ
= arc_p
;
2078 for (arc_p
= NULL
, arc
= fn
->blocks
[ix
].pred
; arc
;
2079 arc_p
= arc
, arc
= arc_n
)
2081 arc_n
= arc
->pred_next
;
2082 arc
->pred_next
= arc_p
;
2084 fn
->blocks
[ix
].pred
= arc_p
;
2087 if (fn
->blocks
.size () < 2)
2088 fnotice (stderr
, "%s:'%s' lacks entry and/or exit blocks\n",
2089 bbg_file_name
, fn
->get_name ());
2092 if (fn
->blocks
[ENTRY_BLOCK
].num_pred
)
2093 fnotice (stderr
, "%s:'%s' has arcs to entry block\n",
2094 bbg_file_name
, fn
->get_name ());
2096 /* We can't deduce the entry block counts from the lack of
2098 fn
->blocks
[ENTRY_BLOCK
].num_pred
= ~(unsigned)0;
2100 if (fn
->blocks
[EXIT_BLOCK
].num_succ
)
2101 fnotice (stderr
, "%s:'%s' has arcs from exit block\n",
2102 bbg_file_name
, fn
->get_name ());
2104 /* Likewise, we can't deduce exit block counts from the lack
2105 of its successors. */
2106 fn
->blocks
[EXIT_BLOCK
].num_succ
= ~(unsigned)0;
2109 /* Propagate the measured counts, this must be done in the same
2110 order as the code in profile.c */
2111 for (unsigned i
= 0; i
< fn
->blocks
.size (); i
++)
2113 blk
= &fn
->blocks
[i
];
2114 block_info
const *prev_dst
= NULL
;
2115 int out_of_order
= 0;
2116 int non_fake_succ
= 0;
2118 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2126 arc
->count
= *count_ptr
++;
2127 arc
->count_valid
= 1;
2129 arc
->dst
->num_pred
--;
2131 if (prev_dst
&& prev_dst
> arc
->dst
)
2133 prev_dst
= arc
->dst
;
2135 if (non_fake_succ
== 1)
2137 /* If there is only one non-fake exit, it is an
2138 unconditional branch. */
2139 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2142 arc
->is_unconditional
= 1;
2143 /* If this block is instrumenting a call, it might be
2144 an artificial block. It is not artificial if it has
2145 a non-fallthrough exit, or the destination of this
2146 arc has more than one entry. Mark the destination
2147 block as a return site, if none of those conditions
2149 if (blk
->is_call_site
&& arc
->fall_through
2150 && arc
->dst
->pred
== arc
&& !arc
->pred_next
)
2151 arc
->dst
->is_call_return
= 1;
2155 /* Sort the successor arcs into ascending dst order. profile.c
2156 normally produces arcs in the right order, but sometimes with
2157 one or two out of order. We're not using a particularly
2161 arc_info
*start
= blk
->succ
;
2162 unsigned changes
= 1;
2166 arc_info
*arc
, *arc_p
, *arc_n
;
2169 for (arc_p
= NULL
, arc
= start
; (arc_n
= arc
->succ_next
);)
2171 if (arc
->dst
> arc_n
->dst
)
2175 arc_p
->succ_next
= arc_n
;
2178 arc
->succ_next
= arc_n
->succ_next
;
2179 arc_n
->succ_next
= arc
;
2192 /* Place it on the invalid chain, it will be ignored if that's
2194 blk
->invalid_chain
= 1;
2195 blk
->chain
= invalid_blocks
;
2196 invalid_blocks
= blk
;
2199 while (invalid_blocks
|| valid_blocks
)
2201 while ((blk
= invalid_blocks
))
2203 gcov_type total
= 0;
2204 const arc_info
*arc
;
2206 invalid_blocks
= blk
->chain
;
2207 blk
->invalid_chain
= 0;
2209 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2210 total
+= arc
->count
;
2211 else if (!blk
->num_pred
)
2212 for (arc
= blk
->pred
; arc
; arc
= arc
->pred_next
)
2213 total
+= arc
->count
;
2218 blk
->count_valid
= 1;
2219 blk
->chain
= valid_blocks
;
2220 blk
->valid_chain
= 1;
2223 while ((blk
= valid_blocks
))
2226 arc_info
*arc
, *inv_arc
;
2228 valid_blocks
= blk
->chain
;
2229 blk
->valid_chain
= 0;
2230 if (blk
->num_succ
== 1)
2236 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2238 total
-= arc
->count
;
2239 if (!arc
->count_valid
)
2243 inv_arc
->count_valid
= 1;
2244 inv_arc
->count
= total
;
2247 if (dst
->count_valid
)
2249 if (dst
->num_pred
== 1 && !dst
->valid_chain
)
2251 dst
->chain
= valid_blocks
;
2252 dst
->valid_chain
= 1;
2258 if (!dst
->num_pred
&& !dst
->invalid_chain
)
2260 dst
->chain
= invalid_blocks
;
2261 dst
->invalid_chain
= 1;
2262 invalid_blocks
= dst
;
2266 if (blk
->num_pred
== 1)
2272 for (arc
= blk
->pred
; arc
; arc
= arc
->pred_next
)
2274 total
-= arc
->count
;
2275 if (!arc
->count_valid
)
2279 inv_arc
->count_valid
= 1;
2280 inv_arc
->count
= total
;
2283 if (src
->count_valid
)
2285 if (src
->num_succ
== 1 && !src
->valid_chain
)
2287 src
->chain
= valid_blocks
;
2288 src
->valid_chain
= 1;
2294 if (!src
->num_succ
&& !src
->invalid_chain
)
2296 src
->chain
= invalid_blocks
;
2297 src
->invalid_chain
= 1;
2298 invalid_blocks
= src
;
2305 /* If the graph has been correctly solved, every block will have a
2307 for (unsigned i
= 0; ix
< fn
->blocks
.size (); i
++)
2308 if (!fn
->blocks
[i
].count_valid
)
2310 fnotice (stderr
, "%s:graph is unsolvable for '%s'\n",
2311 bbg_file_name
, fn
->get_name ());
2316 /* Mark all the blocks only reachable via an incoming catch. */
2319 find_exception_blocks (function_info
*fn
)
2322 block_info
**queue
= XALLOCAVEC (block_info
*, fn
->blocks
.size ());
2324 /* First mark all blocks as exceptional. */
2325 for (ix
= fn
->blocks
.size (); ix
--;)
2326 fn
->blocks
[ix
].exceptional
= 1;
2328 /* Now mark all the blocks reachable via non-fake edges */
2329 queue
[0] = &fn
->blocks
[0];
2330 queue
[0]->exceptional
= 0;
2333 block_info
*block
= queue
[--ix
];
2334 const arc_info
*arc
;
2336 for (arc
= block
->succ
; arc
; arc
= arc
->succ_next
)
2337 if (!arc
->fake
&& !arc
->is_throw
&& arc
->dst
->exceptional
)
2339 arc
->dst
->exceptional
= 0;
2340 queue
[ix
++] = arc
->dst
;
2346 /* Increment totals in COVERAGE according to arc ARC. */
2349 add_branch_counts (coverage_info
*coverage
, const arc_info
*arc
)
2351 if (arc
->is_call_non_return
)
2354 if (arc
->src
->count
)
2355 coverage
->calls_executed
++;
2357 else if (!arc
->is_unconditional
)
2359 coverage
->branches
++;
2360 if (arc
->src
->count
)
2361 coverage
->branches_executed
++;
2363 coverage
->branches_taken
++;
2367 /* Format COUNT, if flag_human_readable_numbers is set, return it human
2371 format_count (gcov_type count
)
2373 static char buffer
[64];
2374 const char *units
= " kMGTPEZY";
2376 if (count
< 1000 || !flag_human_readable_numbers
)
2378 sprintf (buffer
, "%" PRId64
, count
);
2383 gcov_type divisor
= 1;
2384 for (i
= 0; units
[i
+1]; i
++, divisor
*= 1000)
2386 if (count
+ divisor
/ 2 < 1000 * divisor
)
2389 float r
= 1.0f
* count
/ divisor
;
2390 sprintf (buffer
, "%.1f%c", r
, units
[i
]);
2394 /* Format a GCOV_TYPE integer as either a percent ratio, or absolute
2395 count. If DECIMAL_PLACES >= 0, format TOP/BOTTOM * 100 to DECIMAL_PLACES.
2396 If DECIMAL_PLACES is zero, no decimal point is printed. Only print 100% when
2397 TOP==BOTTOM and only print 0% when TOP=0. If DECIMAL_PLACES < 0, then simply
2398 format TOP. Return pointer to a static string. */
2401 format_gcov (gcov_type top
, gcov_type bottom
, int decimal_places
)
2403 static char buffer
[20];
2405 if (decimal_places
>= 0)
2407 float ratio
= bottom
? 100.0f
* top
/ bottom
: 0;
2409 /* Round up to 1% if there's a small non-zero value. */
2410 if (ratio
> 0.0f
&& ratio
< 0.5f
&& decimal_places
== 0)
2412 sprintf (buffer
, "%.*f%%", decimal_places
, ratio
);
2415 return format_count (top
);
2420 /* Summary of execution */
2423 executed_summary (unsigned lines
, unsigned executed
)
2426 fnotice (stdout
, "Lines executed:%s of %d\n",
2427 format_gcov (executed
, lines
, 2), lines
);
2429 fnotice (stdout
, "No executable lines\n");
2432 /* Output summary info for a function. */
2435 function_summary (const coverage_info
*coverage
)
2437 fnotice (stdout
, "%s '%s'\n", "Function", coverage
->name
);
2438 executed_summary (coverage
->lines
, coverage
->lines_executed
);
2441 /* Output summary info for a file. */
2444 file_summary (const coverage_info
*coverage
)
2446 fnotice (stdout
, "%s '%s'\n", "File", coverage
->name
);
2447 executed_summary (coverage
->lines
, coverage
->lines_executed
);
2451 if (coverage
->branches
)
2453 fnotice (stdout
, "Branches executed:%s of %d\n",
2454 format_gcov (coverage
->branches_executed
,
2455 coverage
->branches
, 2),
2456 coverage
->branches
);
2457 fnotice (stdout
, "Taken at least once:%s of %d\n",
2458 format_gcov (coverage
->branches_taken
,
2459 coverage
->branches
, 2),
2460 coverage
->branches
);
2463 fnotice (stdout
, "No branches\n");
2464 if (coverage
->calls
)
2465 fnotice (stdout
, "Calls executed:%s of %d\n",
2466 format_gcov (coverage
->calls_executed
, coverage
->calls
, 2),
2469 fnotice (stdout
, "No calls\n");
2473 /* Canonicalize the filename NAME by canonicalizing directory
2474 separators, eliding . components and resolving .. components
2475 appropriately. Always returns a unique string. */
2478 canonicalize_name (const char *name
)
2480 /* The canonical name cannot be longer than the incoming name. */
2481 char *result
= XNEWVEC (char, strlen (name
) + 1);
2482 const char *base
= name
, *probe
;
2487 #if HAVE_DOS_BASED_FILE_SYSTEM
2488 if (base
[0] && base
[1] == ':')
2490 result
[0] = base
[0];
2496 for (dd_base
= ptr
; *base
; base
= probe
)
2500 for (probe
= base
; *probe
; probe
++)
2501 if (IS_DIR_SEPARATOR (*probe
))
2505 if (len
== 1 && base
[0] == '.')
2506 /* Elide a '.' directory */
2508 else if (len
== 2 && base
[0] == '.' && base
[1] == '.')
2510 /* '..', we can only elide it and the previous directory, if
2511 we're not a symlink. */
2512 struct stat ATTRIBUTE_UNUSED buf
;
2516 #if defined (S_ISLNK)
2517 /* S_ISLNK is not POSIX.1-1996. */
2518 || stat (result
, &buf
) || S_ISLNK (buf
.st_mode
)
2522 /* Cannot elide, or unreadable or a symlink. */
2523 dd_base
= ptr
+ 2 + slash
;
2526 while (ptr
!= dd_base
&& *ptr
!= '/')
2528 slash
= ptr
!= result
;
2533 /* Regular pathname component. */
2536 memcpy (ptr
, base
, len
);
2541 for (; IS_DIR_SEPARATOR (*probe
); probe
++)
2549 /* Print hex representation of 16 bytes from SUM and write it to BUFFER. */
2552 md5sum_to_hex (const char *sum
, char *buffer
)
2554 for (unsigned i
= 0; i
< 16; i
++)
2555 sprintf (buffer
+ (2 * i
), "%02x", (unsigned char)sum
[i
]);
2558 /* Generate an output file name. INPUT_NAME is the canonicalized main
2559 input file and SRC_NAME is the canonicalized file name.
2560 LONG_OUTPUT_NAMES and PRESERVE_PATHS affect name generation. With
2561 long_output_names we prepend the processed name of the input file
2562 to each output name (except when the current source file is the
2563 input file, so you don't get a double concatenation). The two
2564 components are separated by '##'. With preserve_paths we create a
2565 filename from all path components of the source file, replacing '/'
2566 with '#', and .. with '^', without it we simply take the basename
2567 component. (Remember, the canonicalized name will already have
2568 elided '.' components and converted \\ separators.) */
2571 make_gcov_file_name (const char *input_name
, const char *src_name
)
2576 if (flag_long_names
&& input_name
&& strcmp (src_name
, input_name
))
2578 /* Generate the input filename part. */
2579 result
= XNEWVEC (char, strlen (input_name
) + strlen (src_name
) + 10);
2582 ptr
= mangle_name (input_name
, ptr
);
2583 ptr
[0] = ptr
[1] = '#';
2588 result
= XNEWVEC (char, strlen (src_name
) + 10);
2592 ptr
= mangle_name (src_name
, ptr
);
2593 strcpy (ptr
, ".gcov");
2595 /* When hashing filenames, we shorten them by only using the filename
2596 component and appending a hash of the full (mangled) pathname. */
2597 if (flag_hash_filenames
)
2601 char md5sum_hex
[33];
2603 md5_init_ctx (&ctx
);
2604 md5_process_bytes (src_name
, strlen (src_name
), &ctx
);
2605 md5_finish_ctx (&ctx
, md5sum
);
2606 md5sum_to_hex (md5sum
, md5sum_hex
);
2609 result
= XNEWVEC (char, strlen (src_name
) + 50);
2611 ptr
= mangle_name (src_name
, ptr
);
2612 ptr
[0] = ptr
[1] = '#';
2614 memcpy (ptr
, md5sum_hex
, 32);
2616 strcpy (ptr
, ".gcov");
2622 /* Mangle BASE name, copy it at the beginning of PTR buffer and
2623 return address of the \0 character of the buffer. */
2626 mangle_name (char const *base
, char *ptr
)
2630 /* Generate the source filename part. */
2631 if (!flag_preserve_paths
)
2632 base
= lbasename (base
);
2634 base
= mangle_path (base
);
2636 len
= strlen (base
);
2637 memcpy (ptr
, base
, len
);
2643 /* Scan through the bb_data for each line in the block, increment
2644 the line number execution count indicated by the execution count of
2645 the appropriate basic block. */
2648 add_line_counts (coverage_info
*coverage
, function_info
*fn
)
2650 bool has_any_line
= false;
2651 /* Scan each basic block. */
2652 for (unsigned ix
= 0; ix
!= fn
->blocks
.size (); ix
++)
2654 line_info
*line
= NULL
;
2655 block_info
*block
= &fn
->blocks
[ix
];
2656 if (block
->count
&& ix
&& ix
+ 1 != fn
->blocks
.size ())
2657 fn
->blocks_executed
++;
2658 for (unsigned i
= 0; i
< block
->locations
.size (); i
++)
2660 unsigned src_idx
= block
->locations
[i
].source_file_idx
;
2661 vector
<unsigned> &lines
= block
->locations
[i
].lines
;
2663 block
->cycle
.arc
= NULL
;
2664 block
->cycle
.ident
= ~0U;
2666 for (unsigned j
= 0; j
< lines
.size (); j
++)
2668 unsigned ln
= lines
[j
];
2670 /* Line belongs to a function that is in a group. */
2671 if (fn
->group_line_p (ln
, src_idx
))
2673 gcc_assert (lines
[j
] - fn
->start_line
< fn
->lines
.size ());
2674 line
= &(fn
->lines
[lines
[j
] - fn
->start_line
]);
2676 if (!block
->exceptional
)
2678 line
->unexceptional
= 1;
2679 if (block
->count
== 0)
2680 line
->has_unexecuted_block
= 1;
2682 line
->count
+= block
->count
;
2686 gcc_assert (ln
< sources
[src_idx
].lines
.size ());
2687 line
= &(sources
[src_idx
].lines
[ln
]);
2692 if (!line
->count
&& block
->count
)
2693 coverage
->lines_executed
++;
2696 if (!block
->exceptional
)
2698 line
->unexceptional
= 1;
2699 if (block
->count
== 0)
2700 line
->has_unexecuted_block
= 1;
2702 line
->count
+= block
->count
;
2706 has_any_line
= true;
2708 if (!ix
|| ix
+ 1 == fn
->blocks
.size ())
2709 /* Entry or exit block. */;
2710 else if (line
!= NULL
)
2712 line
->blocks
.push_back (block
);
2718 for (arc
= block
->succ
; arc
; arc
= arc
->succ_next
)
2719 line
->branches
.push_back (arc
);
2726 fnotice (stderr
, "%s:no lines for '%s'\n", bbg_file_name
,
2730 /* Accumulate info for LINE that belongs to SRC source file. If ADD_COVERAGE
2731 is set to true, update source file summary. */
2733 static void accumulate_line_info (line_info
*line
, source_info
*src
,
2737 for (vector
<arc_info
*>::iterator it
= line
->branches
.begin ();
2738 it
!= line
->branches
.end (); it
++)
2739 add_branch_counts (&src
->coverage
, *it
);
2741 if (!line
->blocks
.empty ())
2743 /* The user expects the line count to be the number of times
2744 a line has been executed. Simply summing the block count
2745 will give an artificially high number. The Right Thing
2746 is to sum the entry counts to the graph of blocks on this
2747 line, then find the elementary cycles of the local graph
2748 and add the transition counts of those cycles. */
2749 gcov_type count
= 0;
2751 /* Cycle detection. */
2752 for (vector
<block_info
*>::iterator it
= line
->blocks
.begin ();
2753 it
!= line
->blocks
.end (); it
++)
2755 for (arc_info
*arc
= (*it
)->pred
; arc
; arc
= arc
->pred_next
)
2756 if (!line
->has_block (arc
->src
))
2757 count
+= arc
->count
;
2758 for (arc_info
*arc
= (*it
)->succ
; arc
; arc
= arc
->succ_next
)
2759 arc
->cs_count
= arc
->count
;
2762 /* Now, add the count of loops entirely on this line. */
2763 count
+= get_cycles_count (*line
);
2764 line
->count
= count
;
2766 if (line
->count
> src
->maximum_count
)
2767 src
->maximum_count
= line
->count
;
2770 if (line
->exists
&& add_coverage
)
2772 src
->coverage
.lines
++;
2774 src
->coverage
.lines_executed
++;
2778 /* Accumulate the line counts of a file. */
2781 accumulate_line_counts (source_info
*src
)
2783 /* First work on group functions. */
2784 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
2785 it
!= src
->functions
.end (); it
++)
2787 function_info
*fn
= *it
;
2789 if (fn
->src
!= src
->index
|| !fn
->is_group
)
2792 for (vector
<line_info
>::iterator it2
= fn
->lines
.begin ();
2793 it2
!= fn
->lines
.end (); it2
++)
2795 line_info
*line
= &(*it2
);
2796 accumulate_line_info (line
, src
, false);
2800 /* Work on global lines that line in source file SRC. */
2801 for (vector
<line_info
>::iterator it
= src
->lines
.begin ();
2802 it
!= src
->lines
.end (); it
++)
2803 accumulate_line_info (&(*it
), src
, true);
2805 /* If not using intermediate mode, sum lines of group functions and
2806 add them to lines that live in a source file. */
2807 if (!flag_json_format
)
2808 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
2809 it
!= src
->functions
.end (); it
++)
2811 function_info
*fn
= *it
;
2813 if (fn
->src
!= src
->index
|| !fn
->is_group
)
2816 for (unsigned i
= 0; i
< fn
->lines
.size (); i
++)
2818 line_info
*fn_line
= &fn
->lines
[i
];
2819 if (fn_line
->exists
)
2821 unsigned ln
= fn
->start_line
+ i
;
2822 line_info
*src_line
= &src
->lines
[ln
];
2824 if (!src_line
->exists
)
2825 src
->coverage
.lines
++;
2826 if (!src_line
->count
&& fn_line
->count
)
2827 src
->coverage
.lines_executed
++;
2829 src_line
->count
+= fn_line
->count
;
2830 src_line
->exists
= 1;
2832 if (fn_line
->has_unexecuted_block
)
2833 src_line
->has_unexecuted_block
= 1;
2835 if (fn_line
->unexceptional
)
2836 src_line
->unexceptional
= 1;
2842 /* Output information about ARC number IX. Returns nonzero if
2843 anything is output. */
2846 output_branch_count (FILE *gcov_file
, int ix
, const arc_info
*arc
)
2848 if (arc
->is_call_non_return
)
2850 if (arc
->src
->count
)
2852 fnotice (gcov_file
, "call %2d returned %s\n", ix
,
2853 format_gcov (arc
->src
->count
- arc
->count
,
2854 arc
->src
->count
, -flag_counts
));
2857 fnotice (gcov_file
, "call %2d never executed\n", ix
);
2859 else if (!arc
->is_unconditional
)
2861 if (arc
->src
->count
)
2862 fnotice (gcov_file
, "branch %2d taken %s%s", ix
,
2863 format_gcov (arc
->count
, arc
->src
->count
, -flag_counts
),
2864 arc
->fall_through
? " (fallthrough)"
2865 : arc
->is_throw
? " (throw)" : "");
2867 fnotice (gcov_file
, "branch %2d never executed", ix
);
2870 fnotice (gcov_file
, " (BB %d)", arc
->dst
->id
);
2872 fnotice (gcov_file
, "\n");
2874 else if (flag_unconditional
&& !arc
->dst
->is_call_return
)
2876 if (arc
->src
->count
)
2877 fnotice (gcov_file
, "unconditional %2d taken %s\n", ix
,
2878 format_gcov (arc
->count
, arc
->src
->count
, -flag_counts
));
2880 fnotice (gcov_file
, "unconditional %2d never executed\n", ix
);
2888 read_line (FILE *file
)
2890 static char *string
;
2891 static size_t string_len
;
2898 string
= XNEWVEC (char, string_len
);
2901 while ((ptr
= fgets (string
+ pos
, string_len
- pos
, file
)))
2903 size_t len
= strlen (string
+ pos
);
2905 if (len
&& string
[pos
+ len
- 1] == '\n')
2907 string
[pos
+ len
- 1] = 0;
2911 /* If the file contains NUL characters or an incomplete
2912 last line, which can happen more than once in one run,
2913 we have to avoid doubling the STRING_LEN unnecessarily. */
2914 if (pos
> string_len
/ 2)
2917 string
= XRESIZEVEC (char, string
, string_len
);
2921 return pos
? string
: NULL
;
2924 /* Pad string S with spaces from left to have total width equal to 9. */
2927 pad_count_string (string
&s
)
2930 s
.insert (0, 9 - s
.size (), ' ');
2933 /* Print GCOV line beginning to F stream. If EXISTS is set to true, the
2934 line exists in source file. UNEXCEPTIONAL indicated that it's not in
2935 an exceptional statement. The output is printed for LINE_NUM of given
2936 COUNT of executions. EXCEPTIONAL_STRING and UNEXCEPTIONAL_STRING are
2937 used to indicate non-executed blocks. */
2940 output_line_beginning (FILE *f
, bool exists
, bool unexceptional
,
2941 bool has_unexecuted_block
,
2942 gcov_type count
, unsigned line_num
,
2943 const char *exceptional_string
,
2944 const char *unexceptional_string
,
2945 unsigned int maximum_count
)
2952 s
= format_gcov (count
, 0, -1);
2953 if (has_unexecuted_block
2954 && bbg_supports_has_unexecuted_blocks
)
2956 if (flag_use_colors
)
2958 pad_count_string (s
);
2959 s
.insert (0, SGR_SEQ (COLOR_BG_MAGENTA
2960 COLOR_SEPARATOR COLOR_FG_WHITE
));
2966 pad_count_string (s
);
2970 if (flag_use_colors
)
2973 pad_count_string (s
);
2975 s
.insert (0, SGR_SEQ (COLOR_BG_RED
2976 COLOR_SEPARATOR COLOR_FG_WHITE
));
2978 s
.insert (0, SGR_SEQ (COLOR_BG_CYAN
2979 COLOR_SEPARATOR COLOR_FG_WHITE
));
2984 s
= unexceptional
? unexceptional_string
: exceptional_string
;
2985 pad_count_string (s
);
2992 pad_count_string (s
);
2995 /* Format line number in output. */
2997 sprintf (buffer
, "%5u", line_num
);
2998 string
linestr (buffer
);
3000 if (flag_use_hotness_colors
&& maximum_count
)
3002 if (count
* 2 > maximum_count
) /* > 50%. */
3003 linestr
.insert (0, SGR_SEQ (COLOR_BG_RED
));
3004 else if (count
* 5 > maximum_count
) /* > 20%. */
3005 linestr
.insert (0, SGR_SEQ (COLOR_BG_YELLOW
));
3006 else if (count
* 10 > maximum_count
) /* > 10%. */
3007 linestr
.insert (0, SGR_SEQ (COLOR_BG_GREEN
));
3008 linestr
+= SGR_RESET
;
3011 fprintf (f
, "%s:%s", s
.c_str (), linestr
.c_str ());
3015 print_source_line (FILE *f
, const vector
<const char *> &source_lines
,
3018 gcc_assert (line
>= 1);
3019 gcc_assert (line
<= source_lines
.size ());
3021 fprintf (f
, ":%s\n", source_lines
[line
- 1]);
3024 /* Output line details for LINE and print it to F file. LINE lives on
3028 output_line_details (FILE *f
, const line_info
*line
, unsigned line_num
)
3030 if (flag_all_blocks
)
3036 for (vector
<block_info
*>::const_iterator it
= line
->blocks
.begin ();
3037 it
!= line
->blocks
.end (); it
++)
3039 if (!(*it
)->is_call_return
)
3041 output_line_beginning (f
, line
->exists
,
3042 (*it
)->exceptional
, false,
3043 (*it
)->count
, line_num
,
3044 "%%%%%", "$$$$$", 0);
3045 fprintf (f
, "-block %2d", ix
++);
3047 fprintf (f
, " (BB %u)", (*it
)->id
);
3051 for (arc
= (*it
)->succ
; arc
; arc
= arc
->succ_next
)
3052 jx
+= output_branch_count (f
, jx
, arc
);
3055 else if (flag_branches
)
3060 for (vector
<arc_info
*>::const_iterator it
= line
->branches
.begin ();
3061 it
!= line
->branches
.end (); it
++)
3062 ix
+= output_branch_count (f
, ix
, (*it
));
3066 /* Output detail statistics about function FN to file F. */
3069 output_function_details (FILE *f
, function_info
*fn
)
3074 arc_info
*arc
= fn
->blocks
[EXIT_BLOCK
].pred
;
3075 gcov_type return_count
= fn
->blocks
[EXIT_BLOCK
].count
;
3076 gcov_type called_count
= fn
->blocks
[ENTRY_BLOCK
].count
;
3078 for (; arc
; arc
= arc
->pred_next
)
3080 return_count
-= arc
->count
;
3082 fprintf (f
, "function %s", fn
->get_name ());
3083 fprintf (f
, " called %s",
3084 format_gcov (called_count
, 0, -1));
3085 fprintf (f
, " returned %s",
3086 format_gcov (return_count
, called_count
, 0));
3087 fprintf (f
, " blocks executed %s",
3088 format_gcov (fn
->blocks_executed
, fn
->get_block_count (), 0));
3092 /* Read in the source file one line at a time, and output that line to
3093 the gcov file preceded by its execution count and other
3097 output_lines (FILE *gcov_file
, const source_info
*src
)
3099 #define DEFAULT_LINE_START " -: 0:"
3100 #define FN_SEPARATOR "------------------\n"
3105 /* Print colorization legend. */
3106 if (flag_use_colors
)
3107 fprintf (gcov_file
, "%s",
3108 DEFAULT_LINE_START
"Colorization: profile count: " \
3109 SGR_SEQ (COLOR_BG_CYAN
) "zero coverage (exceptional)" SGR_RESET \
3111 SGR_SEQ (COLOR_BG_RED
) "zero coverage (unexceptional)" SGR_RESET \
3113 SGR_SEQ (COLOR_BG_MAGENTA
) "unexecuted block" SGR_RESET
"\n");
3115 if (flag_use_hotness_colors
)
3116 fprintf (gcov_file
, "%s",
3117 DEFAULT_LINE_START
"Colorization: line numbers: hotness: " \
3118 SGR_SEQ (COLOR_BG_RED
) "> 50%" SGR_RESET
" " \
3119 SGR_SEQ (COLOR_BG_YELLOW
) "> 20%" SGR_RESET
" " \
3120 SGR_SEQ (COLOR_BG_GREEN
) "> 10%" SGR_RESET
"\n");
3122 fprintf (gcov_file
, DEFAULT_LINE_START
"Source:%s\n", src
->coverage
.name
);
3123 if (!multiple_files
)
3125 fprintf (gcov_file
, DEFAULT_LINE_START
"Graph:%s\n", bbg_file_name
);
3126 fprintf (gcov_file
, DEFAULT_LINE_START
"Data:%s\n",
3127 no_data_file
? "-" : da_file_name
);
3128 fprintf (gcov_file
, DEFAULT_LINE_START
"Runs:%u\n", object_runs
);
3131 source_file
= fopen (src
->name
, "r");
3133 fnotice (stderr
, "Cannot open source file %s\n", src
->name
);
3134 else if (src
->file_time
== 0)
3135 fprintf (gcov_file
, DEFAULT_LINE_START
"Source is newer than graph\n");
3137 vector
<const char *> source_lines
;
3139 while ((retval
= read_line (source_file
)) != NULL
)
3140 source_lines
.push_back (xstrdup (retval
));
3142 unsigned line_start_group
= 0;
3143 vector
<function_info
*> *fns
;
3145 for (unsigned line_num
= 1; line_num
<= source_lines
.size (); line_num
++)
3147 if (line_num
>= src
->lines
.size ())
3149 fprintf (gcov_file
, "%9s:%5u", "-", line_num
);
3150 print_source_line (gcov_file
, source_lines
, line_num
);
3154 const line_info
*line
= &src
->lines
[line_num
];
3156 if (line_start_group
== 0)
3158 fns
= src
->get_functions_at_location (line_num
);
3159 if (fns
!= NULL
&& fns
->size () > 1)
3161 /* It's possible to have functions that partially overlap,
3162 thus take the maximum end_line of functions starting
3164 for (unsigned i
= 0; i
< fns
->size (); i
++)
3165 if ((*fns
)[i
]->end_line
> line_start_group
)
3166 line_start_group
= (*fns
)[i
]->end_line
;
3168 else if (fns
!= NULL
&& fns
->size () == 1)
3170 function_info
*fn
= (*fns
)[0];
3171 output_function_details (gcov_file
, fn
);
3175 /* For lines which don't exist in the .bb file, print '-' before
3176 the source line. For lines which exist but were never
3177 executed, print '#####' or '=====' before the source line.
3178 Otherwise, print the execution count before the source line.
3179 There are 16 spaces of indentation added before the source
3180 line so that tabs won't be messed up. */
3181 output_line_beginning (gcov_file
, line
->exists
, line
->unexceptional
,
3182 line
->has_unexecuted_block
, line
->count
,
3183 line_num
, "=====", "#####", src
->maximum_count
);
3185 print_source_line (gcov_file
, source_lines
, line_num
);
3186 output_line_details (gcov_file
, line
, line_num
);
3188 if (line_start_group
== line_num
)
3190 for (vector
<function_info
*>::iterator it
= fns
->begin ();
3191 it
!= fns
->end (); it
++)
3193 function_info
*fn
= *it
;
3194 vector
<line_info
> &lines
= fn
->lines
;
3196 fprintf (gcov_file
, FN_SEPARATOR
);
3198 string fn_name
= fn
->get_name ();
3199 if (flag_use_colors
)
3201 fn_name
.insert (0, SGR_SEQ (COLOR_FG_CYAN
));
3202 fn_name
+= SGR_RESET
;
3205 fprintf (gcov_file
, "%s:\n", fn_name
.c_str ());
3207 output_function_details (gcov_file
, fn
);
3209 /* Print all lines covered by the function. */
3210 for (unsigned i
= 0; i
< lines
.size (); i
++)
3212 line_info
*line
= &lines
[i
];
3213 unsigned l
= fn
->start_line
+ i
;
3215 /* For lines which don't exist in the .bb file, print '-'
3216 before the source line. For lines which exist but
3217 were never executed, print '#####' or '=====' before
3218 the source line. Otherwise, print the execution count
3219 before the source line.
3220 There are 16 spaces of indentation added before the source
3221 line so that tabs won't be messed up. */
3222 output_line_beginning (gcov_file
, line
->exists
,
3223 line
->unexceptional
,
3224 line
->has_unexecuted_block
,
3226 l
, "=====", "#####",
3227 src
->maximum_count
);
3229 print_source_line (gcov_file
, source_lines
, l
);
3230 output_line_details (gcov_file
, line
, l
);
3234 fprintf (gcov_file
, FN_SEPARATOR
);
3235 line_start_group
= 0;
3240 fclose (source_file
);