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 /* Index of the source_info in sources vector. */
377 /* Canonical name of source file. */
381 /* Vector of line information. */
382 vector
<line_info
> lines
;
384 coverage_info coverage
;
386 /* Maximum line count in the source file. */
387 unsigned int maximum_count
;
389 /* Functions in this source file. These are in ascending line
391 vector
<function_info
*> functions
;
393 /* Line number to functions map. */
394 vector
<vector
<function_info
*> *> line_to_function_map
;
397 source_info::source_info (): index (0), name (NULL
), file_time (),
398 lines (), coverage (), maximum_count (0), functions ()
402 /* Register a new function. */
404 source_info::add_function (function_info
*fn
)
406 functions
.push_back (fn
);
408 if (fn
->start_line
>= line_to_function_map
.size ())
409 line_to_function_map
.resize (fn
->start_line
+ 1);
411 vector
<function_info
*> **slot
= &line_to_function_map
[fn
->start_line
];
413 *slot
= new vector
<function_info
*> ();
415 (*slot
)->push_back (fn
);
418 vector
<function_info
*> *
419 source_info::get_functions_at_location (unsigned line_num
) const
421 if (line_num
>= line_to_function_map
.size ())
424 vector
<function_info
*> *slot
= line_to_function_map
[line_num
];
426 std::sort (slot
->begin (), slot
->end (), function_line_start_cmp ());
438 name_map (char *_name
, unsigned _src
): name (_name
), src (_src
)
442 bool operator== (const name_map
&rhs
) const
444 #if HAVE_DOS_BASED_FILE_SYSTEM
445 return strcasecmp (this->name
, rhs
.name
) == 0;
447 return strcmp (this->name
, rhs
.name
) == 0;
451 bool operator< (const name_map
&rhs
) const
453 #if HAVE_DOS_BASED_FILE_SYSTEM
454 return strcasecmp (this->name
, rhs
.name
) < 0;
456 return strcmp (this->name
, rhs
.name
) < 0;
460 const char *name
; /* Source file name */
461 unsigned src
; /* Source file */
464 /* Vector of all functions. */
465 static vector
<function_info
*> functions
;
467 /* Function ident to function_info * map. */
468 static map
<unsigned, function_info
*> ident_to_fn
;
470 /* Vector of source files. */
471 static vector
<source_info
> sources
;
473 /* Mapping of file names to sources */
474 static vector
<name_map
> names
;
476 /* Record all processed files in order to warn about
477 a file being read multiple times. */
478 static vector
<char *> processed_files
;
480 /* This holds data summary information. */
482 static unsigned object_runs
;
484 static unsigned total_lines
;
485 static unsigned total_executed
;
487 /* Modification time of graph file. */
489 static time_t bbg_file_time
;
491 /* Name of the notes (gcno) output file. The "bbg" prefix is for
492 historical reasons, when the notes file contained only the
493 basic block graph notes. */
495 static char *bbg_file_name
;
497 /* Stamp of the bbg file */
498 static unsigned bbg_stamp
;
500 /* Supports has_unexecuted_blocks functionality. */
501 static unsigned bbg_supports_has_unexecuted_blocks
;
503 /* Working directory in which a TU was compiled. */
504 static const char *bbg_cwd
;
506 /* Name and file pointer of the input file for the count data (gcda). */
508 static char *da_file_name
;
510 /* Data file is missing. */
512 static int no_data_file
;
514 /* If there is several input files, compute and display results after
515 reading all data files. This way if two or more gcda file refer to
516 the same source file (eg inline subprograms in a .h file), the
519 static int multiple_files
= 0;
521 /* Output branch probabilities. */
523 static int flag_branches
= 0;
525 /* Show unconditional branches too. */
526 static int flag_unconditional
= 0;
528 /* Output a gcov file if this is true. This is on by default, and can
529 be turned off by the -n option. */
531 static int flag_gcov_file
= 1;
533 /* Output to stdout instead to a gcov file. */
535 static int flag_use_stdout
= 0;
537 /* Output progress indication if this is true. This is off by default
538 and can be turned on by the -d option. */
540 static int flag_display_progress
= 0;
542 /* Output *.gcov file in JSON intermediate format used by consumers. */
544 static int flag_json_format
= 0;
546 /* For included files, make the gcov output file name include the name
547 of the input source file. For example, if x.h is included in a.c,
548 then the output file name is a.c##x.h.gcov instead of x.h.gcov. */
550 static int flag_long_names
= 0;
552 /* For situations when a long name can potentially hit filesystem path limit,
553 let's calculate md5sum of the path and append it to a file name. */
555 static int flag_hash_filenames
= 0;
557 /* Print verbose informations. */
559 static int flag_verbose
= 0;
561 /* Print colored output. */
563 static int flag_use_colors
= 0;
565 /* Use perf-like colors to indicate hot lines. */
567 static int flag_use_hotness_colors
= 0;
569 /* Output count information for every basic block, not merely those
570 that contain line number information. */
572 static int flag_all_blocks
= 0;
574 /* Output human readable numbers. */
576 static int flag_human_readable_numbers
= 0;
578 /* Output summary info for each function. */
580 static int flag_function_summary
= 0;
582 /* Object directory file prefix. This is the directory/file where the
583 graph and data files are looked for, if nonzero. */
585 static char *object_directory
= 0;
587 /* Source directory prefix. This is removed from source pathnames
588 that match, when generating the output file name. */
590 static char *source_prefix
= 0;
591 static size_t source_length
= 0;
593 /* Only show data for sources with relative pathnames. Absolute ones
594 usually indicate a system header file, which although it may
595 contain inline functions, is usually uninteresting. */
596 static int flag_relative_only
= 0;
598 /* Preserve all pathname components. Needed when object files and
599 source files are in subdirectories. '/' is mangled as '#', '.' is
600 elided and '..' mangled to '^'. */
602 static int flag_preserve_paths
= 0;
604 /* Output the number of times a branch was taken as opposed to the percentage
605 of times it was taken. */
607 static int flag_counts
= 0;
609 /* Forward declarations. */
610 static int process_args (int, char **);
611 static void print_usage (int) ATTRIBUTE_NORETURN
;
612 static void print_version (void) ATTRIBUTE_NORETURN
;
613 static void process_file (const char *);
614 static void process_all_functions (void);
615 static void generate_results (const char *);
616 static void create_file_names (const char *);
617 static char *canonicalize_name (const char *);
618 static unsigned find_source (const char *);
619 static void read_graph_file (void);
620 static int read_count_file (void);
621 static void solve_flow_graph (function_info
*);
622 static void find_exception_blocks (function_info
*);
623 static void add_branch_counts (coverage_info
*, const arc_info
*);
624 static void add_line_counts (coverage_info
*, function_info
*);
625 static void executed_summary (unsigned, unsigned);
626 static void function_summary (const coverage_info
*);
627 static void file_summary (const coverage_info
*);
628 static const char *format_gcov (gcov_type
, gcov_type
, int);
629 static void accumulate_line_counts (source_info
*);
630 static void output_gcov_file (const char *, source_info
*);
631 static int output_branch_count (FILE *, int, const arc_info
*);
632 static void output_lines (FILE *, const source_info
*);
633 static char *make_gcov_file_name (const char *, const char *);
634 static char *mangle_name (const char *, char *);
635 static void release_structures (void);
636 extern int main (int, char **);
638 function_info::function_info (): m_name (NULL
), m_demangled_name (NULL
),
639 ident (0), lineno_checksum (0), cfg_checksum (0), has_catch (0),
640 artificial (0), is_group (0),
641 blocks (), blocks_executed (0), counts (),
642 start_line (0), start_column (0), end_line (0), end_column (0),
643 src (0), lines (), next (NULL
)
647 function_info::~function_info ()
649 for (int i
= blocks
.size () - 1; i
>= 0; i
--)
651 arc_info
*arc
, *arc_n
;
653 for (arc
= blocks
[i
].succ
; arc
; arc
= arc_n
)
655 arc_n
= arc
->succ_next
;
659 if (m_demangled_name
!= m_name
)
660 free (m_demangled_name
);
664 bool function_info::group_line_p (unsigned n
, unsigned src_idx
)
666 return is_group
&& src
== src_idx
&& start_line
<= n
&& n
<= end_line
;
670 There are a bajillion algorithms that do this. Boost's function is named
671 hawick_cycles, so I used the algorithm by K. A. Hawick and H. A. James in
672 "Enumerating Circuits and Loops in Graphs with Self-Arcs and Multiple-Arcs"
673 (url at <http://complexity.massey.ac.nz/cstn/013/cstn-013.pdf>).
675 The basic algorithm is simple: effectively, we're finding all simple paths
676 in a subgraph (that shrinks every iteration). Duplicates are filtered by
677 "blocking" a path when a node is added to the path (this also prevents non-
678 simple paths)--the node is unblocked only when it participates in a cycle.
681 typedef vector
<arc_info
*> arc_vector_t
;
682 typedef vector
<const block_info
*> block_vector_t
;
684 /* Handle cycle identified by EDGES, where the function finds minimum cs_count
685 and subtract the value from all counts. The subtracted value is added
686 to COUNT. Returns type of loop. */
689 handle_cycle (const arc_vector_t
&edges
, int64_t &count
)
691 /* Find the minimum edge of the cycle, and reduce all nodes in the cycle by
693 int64_t cycle_count
= INTTYPE_MAXIMUM (int64_t);
694 for (unsigned i
= 0; i
< edges
.size (); i
++)
696 int64_t ecount
= edges
[i
]->cs_count
;
697 if (cycle_count
> ecount
)
698 cycle_count
= ecount
;
700 count
+= cycle_count
;
701 for (unsigned i
= 0; i
< edges
.size (); i
++)
702 edges
[i
]->cs_count
-= cycle_count
;
704 gcc_assert (cycle_count
> 0);
707 /* Unblock a block U from BLOCKED. Apart from that, iterate all blocks
708 blocked by U in BLOCK_LISTS. */
711 unblock (const block_info
*u
, block_vector_t
&blocked
,
712 vector
<block_vector_t
> &block_lists
)
714 block_vector_t::iterator it
= find (blocked
.begin (), blocked
.end (), u
);
715 if (it
== blocked
.end ())
718 unsigned index
= it
- blocked
.begin ();
721 block_vector_t
to_unblock (block_lists
[index
]);
723 block_lists
.erase (block_lists
.begin () + index
);
725 for (block_vector_t::iterator it
= to_unblock
.begin ();
726 it
!= to_unblock
.end (); it
++)
727 unblock (*it
, blocked
, block_lists
);
730 /* Return true when PATH contains a zero cycle arc count. */
733 path_contains_zero_or_negative_cycle_arc (arc_vector_t
&path
)
735 for (unsigned i
= 0; i
< path
.size (); i
++)
736 if (path
[i
]->cs_count
<= 0)
741 /* Find circuit going to block V, PATH is provisional seen cycle.
742 BLOCKED is vector of blocked vertices, BLOCK_LISTS contains vertices
743 blocked by a block. COUNT is accumulated count of the current LINE.
744 Returns what type of loop it contains. */
747 circuit (block_info
*v
, arc_vector_t
&path
, block_info
*start
,
748 block_vector_t
&blocked
, vector
<block_vector_t
> &block_lists
,
749 line_info
&linfo
, int64_t &count
)
751 bool loop_found
= false;
753 /* Add v to the block list. */
754 gcc_assert (find (blocked
.begin (), blocked
.end (), v
) == blocked
.end ());
755 blocked
.push_back (v
);
756 block_lists
.push_back (block_vector_t ());
758 for (arc_info
*arc
= v
->succ
; arc
; arc
= arc
->succ_next
)
760 block_info
*w
= arc
->dst
;
762 || arc
->cs_count
<= 0
763 || !linfo
.has_block (w
))
766 path
.push_back (arc
);
769 /* Cycle has been found. */
770 handle_cycle (path
, count
);
773 else if (!path_contains_zero_or_negative_cycle_arc (path
)
774 && find (blocked
.begin (), blocked
.end (), w
) == blocked
.end ())
775 loop_found
|= circuit (w
, path
, start
, blocked
, block_lists
, linfo
,
782 unblock (v
, blocked
, block_lists
);
784 for (arc_info
*arc
= v
->succ
; arc
; arc
= arc
->succ_next
)
786 block_info
*w
= arc
->dst
;
788 || arc
->cs_count
<= 0
789 || !linfo
.has_block (w
))
793 = find (blocked
.begin (), blocked
.end (), w
) - blocked
.begin ();
794 gcc_assert (index
< blocked
.size ());
795 block_vector_t
&list
= block_lists
[index
];
796 if (find (list
.begin (), list
.end (), v
) == list
.end ())
803 /* Find cycles for a LINFO. */
806 get_cycles_count (line_info
&linfo
)
808 /* Note that this algorithm works even if blocks aren't in sorted order.
809 Each iteration of the circuit detection is completely independent
810 (except for reducing counts, but that shouldn't matter anyways).
811 Therefore, operating on a permuted order (i.e., non-sorted) only
812 has the effect of permuting the output cycles. */
814 bool loop_found
= false;
816 for (vector
<block_info
*>::iterator it
= linfo
.blocks
.begin ();
817 it
!= linfo
.blocks
.end (); it
++)
820 block_vector_t blocked
;
821 vector
<block_vector_t
> block_lists
;
822 loop_found
|= circuit (*it
, path
, *it
, blocked
, block_lists
, linfo
,
830 main (int argc
, char **argv
)
836 p
= argv
[0] + strlen (argv
[0]);
837 while (p
!= argv
[0] && !IS_DIR_SEPARATOR (p
[-1]))
841 xmalloc_set_program_name (progname
);
843 /* Unlock the stdio streams. */
844 unlock_std_streams ();
848 diagnostic_initialize (global_dc
, 0);
850 /* Handle response files. */
851 expandargv (&argc
, &argv
);
853 argno
= process_args (argc
, argv
);
857 if (argc
- argno
> 1)
862 for (; argno
!= argc
; argno
++)
864 if (flag_display_progress
)
865 printf ("Processing file %d out of %d\n", argno
- first_arg
+ 1,
867 process_file (argv
[argno
]);
869 if (flag_json_format
|| argno
== argc
- 1)
871 process_all_functions ();
872 generate_results (argv
[argno
]);
873 release_structures ();
877 if (!flag_use_stdout
)
878 executed_summary (total_lines
, total_executed
);
883 /* Print a usage message and exit. If ERROR_P is nonzero, this is an error,
884 otherwise the output of --help. */
887 print_usage (int error_p
)
889 FILE *file
= error_p
? stderr
: stdout
;
890 int status
= error_p
? FATAL_EXIT_CODE
: SUCCESS_EXIT_CODE
;
892 fnotice (file
, "Usage: gcov [OPTION...] SOURCE|OBJ...\n\n");
893 fnotice (file
, "Print code coverage information.\n\n");
894 fnotice (file
, " -a, --all-blocks Show information for every basic block\n");
895 fnotice (file
, " -b, --branch-probabilities Include branch probabilities in output\n");
896 fnotice (file
, " -c, --branch-counts Output counts of branches taken\n\
897 rather than percentages\n");
898 fnotice (file
, " -d, --display-progress Display progress information\n");
899 fnotice (file
, " -f, --function-summaries Output summaries for each function\n");
900 fnotice (file
, " -h, --help Print this help, then exit\n");
901 fnotice (file
, " -j, --json-format Output JSON intermediate format\n\
902 into .gcov.json.gz file\n");
903 fnotice (file
, " -H, --human-readable Output human readable numbers\n");
904 fnotice (file
, " -k, --use-colors Emit colored output\n");
905 fnotice (file
, " -l, --long-file-names Use long output file names for included\n\
907 fnotice (file
, " -m, --demangled-names Output demangled function names\n");
908 fnotice (file
, " -n, --no-output Do not create an output file\n");
909 fnotice (file
, " -o, --object-directory DIR|FILE Search for object files in DIR or called FILE\n");
910 fnotice (file
, " -p, --preserve-paths Preserve all pathname components\n");
911 fnotice (file
, " -q, --use-hotness-colors Emit perf-like colored output for hot lines\n");
912 fnotice (file
, " -r, --relative-only Only show data for relative sources\n");
913 fnotice (file
, " -s, --source-prefix DIR Source prefix to elide\n");
914 fnotice (file
, " -t, --stdout Output to stdout instead of a file\n");
915 fnotice (file
, " -u, --unconditional-branches Show unconditional branch counts too\n");
916 fnotice (file
, " -v, --version Print version number, then exit\n");
917 fnotice (file
, " -w, --verbose Print verbose informations\n");
918 fnotice (file
, " -x, --hash-filenames Hash long pathnames\n");
919 fnotice (file
, "\nObsolete options:\n");
920 fnotice (file
, " -i, --json-format Replaced with -j, --json-format\n");
921 fnotice (file
, " -j, --human-readable Replaced with -H, --human-readable\n");
922 fnotice (file
, "\nFor bug reporting instructions, please see:\n%s.\n",
927 /* Print version information and exit. */
932 fnotice (stdout
, "gcov %s%s\n", pkgversion_string
, version_string
);
933 fprintf (stdout
, "Copyright %s 2021 Free Software Foundation, Inc.\n",
936 _("This is free software; see the source for copying conditions. There is NO\n\
937 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n"));
938 exit (SUCCESS_EXIT_CODE
);
941 static const struct option options
[] =
943 { "help", no_argument
, NULL
, 'h' },
944 { "version", no_argument
, NULL
, 'v' },
945 { "verbose", no_argument
, NULL
, 'w' },
946 { "all-blocks", no_argument
, NULL
, 'a' },
947 { "branch-probabilities", no_argument
, NULL
, 'b' },
948 { "branch-counts", no_argument
, NULL
, 'c' },
949 { "json-format", no_argument
, NULL
, 'j' },
950 { "human-readable", no_argument
, NULL
, 'H' },
951 { "no-output", no_argument
, NULL
, 'n' },
952 { "long-file-names", no_argument
, NULL
, 'l' },
953 { "function-summaries", no_argument
, NULL
, 'f' },
954 { "demangled-names", no_argument
, NULL
, 'm' },
955 { "preserve-paths", no_argument
, NULL
, 'p' },
956 { "relative-only", no_argument
, NULL
, 'r' },
957 { "object-directory", required_argument
, NULL
, 'o' },
958 { "object-file", required_argument
, NULL
, 'o' },
959 { "source-prefix", required_argument
, NULL
, 's' },
960 { "stdout", no_argument
, NULL
, 't' },
961 { "unconditional-branches", no_argument
, NULL
, 'u' },
962 { "display-progress", no_argument
, NULL
, 'd' },
963 { "hash-filenames", no_argument
, NULL
, 'x' },
964 { "use-colors", no_argument
, NULL
, 'k' },
965 { "use-hotness-colors", no_argument
, NULL
, 'q' },
969 /* Process args, return index to first non-arg. */
972 process_args (int argc
, char **argv
)
976 const char *opts
= "abcdfhHijklmno:pqrs:tuvwx";
977 while ((opt
= getopt_long (argc
, argv
, opts
, options
, NULL
)) != -1)
991 flag_function_summary
= 1;
995 /* print_usage will exit. */
1000 flag_human_readable_numbers
= 1;
1003 flag_use_colors
= 1;
1006 flag_use_hotness_colors
= 1;
1009 flag_demangled_names
= 1;
1015 object_directory
= optarg
;
1018 source_prefix
= optarg
;
1019 source_length
= strlen (source_prefix
);
1022 flag_relative_only
= 1;
1025 flag_preserve_paths
= 1;
1028 flag_unconditional
= 1;
1032 flag_json_format
= 1;
1036 flag_display_progress
= 1;
1039 flag_hash_filenames
= 1;
1045 flag_use_stdout
= 1;
1049 /* print_version will exit. */
1052 /* print_usage will exit. */
1059 /* Output intermediate LINE sitting on LINE_NUM to JSON OBJECT.
1060 Add FUNCTION_NAME to the LINE. */
1063 output_intermediate_json_line (json::array
*object
,
1064 line_info
*line
, unsigned line_num
,
1065 const char *function_name
)
1070 json::object
*lineo
= new json::object ();
1071 lineo
->set ("line_number", new json::integer_number (line_num
));
1072 if (function_name
!= NULL
)
1073 lineo
->set ("function_name", new json::string (function_name
));
1074 lineo
->set ("count", new json::integer_number (line
->count
));
1075 lineo
->set ("unexecuted_block",
1076 new json::literal (line
->has_unexecuted_block
));
1078 json::array
*branches
= new json::array ();
1079 lineo
->set ("branches", branches
);
1081 vector
<arc_info
*>::const_iterator it
;
1083 for (it
= line
->branches
.begin (); it
!= line
->branches
.end ();
1086 if (!(*it
)->is_unconditional
&& !(*it
)->is_call_non_return
)
1088 json::object
*branch
= new json::object ();
1089 branch
->set ("count", new json::integer_number ((*it
)->count
));
1090 branch
->set ("throw", new json::literal ((*it
)->is_throw
));
1091 branch
->set ("fallthrough",
1092 new json::literal ((*it
)->fall_through
));
1093 branches
->append (branch
);
1097 object
->append (lineo
);
1100 /* Get the name of the gcov file. The return value must be free'd.
1102 It appends the '.gcov' extension to the *basename* of the file.
1103 The resulting file name will be in PWD.
1106 input: foo.da, output: foo.da.gcov
1107 input: a/b/foo.cc, output: foo.cc.gcov */
1110 get_gcov_intermediate_filename (const char *file_name
)
1112 const char *gcov
= ".gcov.json.gz";
1116 /* Find the 'basename'. */
1117 cptr
= lbasename (file_name
);
1119 result
= XNEWVEC (char, strlen (cptr
) + strlen (gcov
) + 1);
1120 sprintf (result
, "%s%s", cptr
, gcov
);
1125 /* Output the result in JSON intermediate format.
1126 Source info SRC is dumped into JSON_FILES which is JSON array. */
1129 output_json_intermediate_file (json::array
*json_files
, source_info
*src
)
1131 json::object
*root
= new json::object ();
1132 json_files
->append (root
);
1134 root
->set ("file", new json::string (src
->name
));
1136 json::array
*functions
= new json::array ();
1137 root
->set ("functions", functions
);
1139 std::sort (src
->functions
.begin (), src
->functions
.end (),
1140 function_line_start_cmp ());
1141 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
1142 it
!= src
->functions
.end (); it
++)
1144 json::object
*function
= new json::object ();
1145 function
->set ("name", new json::string ((*it
)->m_name
));
1146 function
->set ("demangled_name",
1147 new json::string ((*it
)->get_demangled_name ()));
1148 function
->set ("start_line",
1149 new json::integer_number ((*it
)->start_line
));
1150 function
->set ("start_column",
1151 new json::integer_number ((*it
)->start_column
));
1152 function
->set ("end_line", new json::integer_number ((*it
)->end_line
));
1153 function
->set ("end_column",
1154 new json::integer_number ((*it
)->end_column
));
1155 function
->set ("blocks",
1156 new json::integer_number ((*it
)->get_block_count ()));
1157 function
->set ("blocks_executed",
1158 new json::integer_number ((*it
)->blocks_executed
));
1159 function
->set ("execution_count",
1160 new json::integer_number ((*it
)->blocks
[0].count
));
1162 functions
->append (function
);
1165 json::array
*lineso
= new json::array ();
1166 root
->set ("lines", lineso
);
1168 vector
<function_info
*> last_non_group_fns
;
1170 for (unsigned line_num
= 1; line_num
<= src
->lines
.size (); line_num
++)
1172 vector
<function_info
*> *fns
= src
->get_functions_at_location (line_num
);
1175 /* Print info for all group functions that begin on the line. */
1176 for (vector
<function_info
*>::iterator it2
= fns
->begin ();
1177 it2
!= fns
->end (); it2
++)
1179 if (!(*it2
)->is_group
)
1180 last_non_group_fns
.push_back (*it2
);
1182 vector
<line_info
> &lines
= (*it2
)->lines
;
1183 /* The LINES array is allocated only for group functions. */
1184 for (unsigned i
= 0; i
< lines
.size (); i
++)
1186 line_info
*line
= &lines
[i
];
1187 output_intermediate_json_line (lineso
, line
, line_num
+ i
,
1192 /* Follow with lines associated with the source file. */
1193 if (line_num
< src
->lines
.size ())
1195 unsigned size
= last_non_group_fns
.size ();
1196 function_info
*last_fn
= size
> 0 ? last_non_group_fns
[size
- 1] : NULL
;
1197 const char *fname
= last_fn
? last_fn
->m_name
: NULL
;
1198 output_intermediate_json_line (lineso
, &src
->lines
[line_num
], line_num
,
1201 /* Pop ending function from stack. */
1202 if (last_fn
!= NULL
&& last_fn
->end_line
== line_num
)
1203 last_non_group_fns
.pop_back ();
1208 /* Function start pair. */
1209 struct function_start
1211 unsigned source_file_idx
;
1212 unsigned start_line
;
1215 /* Traits class for function start hash maps below. */
1217 struct function_start_pair_hash
: typed_noop_remove
<function_start
>
1219 typedef function_start value_type
;
1220 typedef function_start compare_type
;
1223 hash (const function_start
&ref
)
1225 inchash::hash
hstate (0);
1226 hstate
.add_int (ref
.source_file_idx
);
1227 hstate
.add_int (ref
.start_line
);
1228 return hstate
.end ();
1232 equal (const function_start
&ref1
, const function_start
&ref2
)
1234 return (ref1
.source_file_idx
== ref2
.source_file_idx
1235 && ref1
.start_line
== ref2
.start_line
);
1239 mark_deleted (function_start
&ref
)
1241 ref
.start_line
= ~1U;
1244 static const bool empty_zero_p
= false;
1247 mark_empty (function_start
&ref
)
1249 ref
.start_line
= ~2U;
1253 is_deleted (const function_start
&ref
)
1255 return ref
.start_line
== ~1U;
1259 is_empty (const function_start
&ref
)
1261 return ref
.start_line
== ~2U;
1265 /* Process a single input file. */
1268 process_file (const char *file_name
)
1270 create_file_names (file_name
);
1272 for (unsigned i
= 0; i
< processed_files
.size (); i
++)
1273 if (strcmp (da_file_name
, processed_files
[i
]) == 0)
1275 fnotice (stderr
, "'%s' file is already processed\n",
1280 processed_files
.push_back (xstrdup (da_file_name
));
1286 /* Process all functions in all files. */
1289 process_all_functions (void)
1291 hash_map
<function_start_pair_hash
, function_info
*> fn_map
;
1293 /* Identify group functions. */
1294 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1295 it
!= functions
.end (); it
++)
1296 if (!(*it
)->artificial
)
1298 function_start needle
;
1299 needle
.source_file_idx
= (*it
)->src
;
1300 needle
.start_line
= (*it
)->start_line
;
1302 function_info
**slot
= fn_map
.get (needle
);
1305 (*slot
)->is_group
= 1;
1306 (*it
)->is_group
= 1;
1309 fn_map
.put (needle
, *it
);
1312 /* Remove all artificial function. */
1313 functions
.erase (remove_if (functions
.begin (), functions
.end (),
1314 function_info::is_artificial
), functions
.end ());
1316 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1317 it
!= functions
.end (); it
++)
1319 function_info
*fn
= *it
;
1320 unsigned src
= fn
->src
;
1322 if (!fn
->counts
.empty () || no_data_file
)
1324 source_info
*s
= &sources
[src
];
1325 s
->add_function (fn
);
1327 /* Mark last line in files touched by function. */
1328 for (unsigned block_no
= 0; block_no
!= fn
->blocks
.size ();
1331 block_info
*block
= &fn
->blocks
[block_no
];
1332 for (unsigned i
= 0; i
< block
->locations
.size (); i
++)
1334 /* Sort lines of locations. */
1335 sort (block
->locations
[i
].lines
.begin (),
1336 block
->locations
[i
].lines
.end ());
1338 if (!block
->locations
[i
].lines
.empty ())
1340 s
= &sources
[block
->locations
[i
].source_file_idx
];
1342 = block
->locations
[i
].lines
.back ();
1344 /* Record new lines for the function. */
1345 if (last_line
>= s
->lines
.size ())
1347 s
= &sources
[block
->locations
[i
].source_file_idx
];
1349 = block
->locations
[i
].lines
.back ();
1351 /* Record new lines for the function. */
1352 if (last_line
>= s
->lines
.size ())
1354 /* Record new lines for a source file. */
1355 s
->lines
.resize (last_line
+ 1);
1362 /* Allocate lines for group function, following start_line
1363 and end_line information of the function. */
1365 fn
->lines
.resize (fn
->end_line
- fn
->start_line
+ 1);
1367 solve_flow_graph (fn
);
1369 find_exception_blocks (fn
);
1373 /* The function was not in the executable -- some other
1374 instance must have been selected. */
1380 output_gcov_file (const char *file_name
, source_info
*src
)
1382 char *gcov_file_name
= make_gcov_file_name (file_name
, src
->coverage
.name
);
1384 if (src
->coverage
.lines
)
1386 FILE *gcov_file
= fopen (gcov_file_name
, "w");
1389 fnotice (stdout
, "Creating '%s'\n", gcov_file_name
);
1390 output_lines (gcov_file
, src
);
1391 if (ferror (gcov_file
))
1392 fnotice (stderr
, "Error writing output file '%s'\n",
1397 fnotice (stderr
, "Could not open output file '%s'\n", gcov_file_name
);
1401 unlink (gcov_file_name
);
1402 fnotice (stdout
, "Removing '%s'\n", gcov_file_name
);
1404 free (gcov_file_name
);
1408 generate_results (const char *file_name
)
1410 char *gcov_intermediate_filename
;
1412 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1413 it
!= functions
.end (); it
++)
1415 function_info
*fn
= *it
;
1416 coverage_info coverage
;
1418 memset (&coverage
, 0, sizeof (coverage
));
1419 coverage
.name
= fn
->get_name ();
1420 add_line_counts (flag_function_summary
? &coverage
: NULL
, fn
);
1421 if (flag_function_summary
)
1423 function_summary (&coverage
);
1424 fnotice (stdout
, "\n");
1429 needle
.name
= file_name
;
1430 vector
<name_map
>::iterator it
1431 = std::find (names
.begin (), names
.end (), needle
);
1432 if (it
!= names
.end ())
1433 file_name
= sources
[it
->src
].coverage
.name
;
1435 file_name
= canonicalize_name (file_name
);
1437 gcov_intermediate_filename
= get_gcov_intermediate_filename (file_name
);
1439 json::object
*root
= new json::object ();
1440 root
->set ("format_version", new json::string ("1"));
1441 root
->set ("gcc_version", new json::string (version_string
));
1443 if (bbg_cwd
!= NULL
)
1444 root
->set ("current_working_directory", new json::string (bbg_cwd
));
1445 root
->set ("data_file", new json::string (file_name
));
1447 json::array
*json_files
= new json::array ();
1448 root
->set ("files", json_files
);
1450 for (vector
<source_info
>::iterator it
= sources
.begin ();
1451 it
!= sources
.end (); it
++)
1453 source_info
*src
= &(*it
);
1454 if (flag_relative_only
)
1456 /* Ignore this source, if it is an absolute path (after
1457 source prefix removal). */
1458 char first
= src
->coverage
.name
[0];
1460 #if HAVE_DOS_BASED_FILE_SYSTEM
1461 if (first
&& src
->coverage
.name
[1] == ':')
1462 first
= src
->coverage
.name
[2];
1464 if (IS_DIR_SEPARATOR (first
))
1468 accumulate_line_counts (src
);
1470 if (!flag_use_stdout
)
1471 file_summary (&src
->coverage
);
1472 total_lines
+= src
->coverage
.lines
;
1473 total_executed
+= src
->coverage
.lines_executed
;
1476 if (flag_json_format
)
1478 output_json_intermediate_file (json_files
, src
);
1479 if (!flag_use_stdout
)
1480 fnotice (stdout
, "\n");
1484 if (flag_use_stdout
)
1486 if (src
->coverage
.lines
)
1487 output_lines (stdout
, src
);
1491 output_gcov_file (file_name
, src
);
1492 fnotice (stdout
, "\n");
1498 if (flag_gcov_file
&& flag_json_format
)
1500 if (flag_use_stdout
)
1502 root
->dump (stdout
);
1509 pp_formatted_text (&pp
);
1511 gzFile output
= gzopen (gcov_intermediate_filename
, "w");
1514 fnotice (stderr
, "Cannot open JSON output file %s\n",
1515 gcov_intermediate_filename
);
1519 if (gzputs (output
, pp_formatted_text (&pp
)) == EOF
1520 || gzclose (output
))
1522 fnotice (stderr
, "Error writing JSON output file %s\n",
1523 gcov_intermediate_filename
);
1530 /* Release all memory used. */
1533 release_structures (void)
1535 for (vector
<function_info
*>::iterator it
= functions
.begin ();
1536 it
!= functions
.end (); it
++)
1541 functions
.resize (0);
1542 ident_to_fn
.clear ();
1545 /* Generate the names of the graph and data files. If OBJECT_DIRECTORY
1546 is not specified, these are named from FILE_NAME sans extension. If
1547 OBJECT_DIRECTORY is specified and is a directory, the files are in that
1548 directory, but named from the basename of the FILE_NAME, sans extension.
1549 Otherwise OBJECT_DIRECTORY is taken to be the name of the object *file*
1550 and the data files are named from that. */
1553 create_file_names (const char *file_name
)
1557 int length
= strlen (file_name
);
1560 /* Free previous file names. */
1561 free (bbg_file_name
);
1562 free (da_file_name
);
1563 da_file_name
= bbg_file_name
= NULL
;
1567 if (object_directory
&& object_directory
[0])
1571 length
+= strlen (object_directory
) + 2;
1572 name
= XNEWVEC (char, length
);
1575 base
= !stat (object_directory
, &status
) && S_ISDIR (status
.st_mode
);
1576 strcat (name
, object_directory
);
1577 if (base
&& (!IS_DIR_SEPARATOR (name
[strlen (name
) - 1])))
1582 name
= XNEWVEC (char, length
+ 1);
1583 strcpy (name
, file_name
);
1589 /* Append source file name. */
1590 const char *cptr
= lbasename (file_name
);
1591 strcat (name
, cptr
? cptr
: file_name
);
1594 /* Remove the extension. */
1595 cptr
= strrchr (CONST_CAST (char *, lbasename (name
)), '.');
1599 length
= strlen (name
);
1601 bbg_file_name
= XNEWVEC (char, length
+ strlen (GCOV_NOTE_SUFFIX
) + 1);
1602 strcpy (bbg_file_name
, name
);
1603 strcpy (bbg_file_name
+ length
, GCOV_NOTE_SUFFIX
);
1605 da_file_name
= XNEWVEC (char, length
+ strlen (GCOV_DATA_SUFFIX
) + 1);
1606 strcpy (da_file_name
, name
);
1607 strcpy (da_file_name
+ length
, GCOV_DATA_SUFFIX
);
1613 /* Find or create a source file structure for FILE_NAME. Copies
1614 FILE_NAME on creation */
1617 find_source (const char *file_name
)
1624 file_name
= "<unknown>";
1627 needle
.name
= file_name
;
1629 vector
<name_map
>::iterator it
= std::find (names
.begin (), names
.end (),
1631 if (it
!= names
.end ())
1637 /* Not found, try the canonical name. */
1638 canon
= canonicalize_name (file_name
);
1639 needle
.name
= canon
;
1640 it
= std::find (names
.begin (), names
.end (), needle
);
1641 if (it
== names
.end ())
1643 /* Not found with canonical name, create a new source. */
1646 idx
= sources
.size ();
1647 needle
= name_map (canon
, idx
);
1648 names
.push_back (needle
);
1650 sources
.push_back (source_info ());
1651 src
= &sources
.back ();
1653 src
->coverage
.name
= src
->name
;
1656 #if HAVE_DOS_BASED_FILE_SYSTEM
1657 /* You lose if separators don't match exactly in the
1659 && !strncasecmp (source_prefix
, src
->coverage
.name
, source_length
)
1661 && !strncmp (source_prefix
, src
->coverage
.name
, source_length
)
1663 && IS_DIR_SEPARATOR (src
->coverage
.name
[source_length
]))
1664 src
->coverage
.name
+= source_length
+ 1;
1665 if (!stat (src
->name
, &status
))
1666 src
->file_time
= status
.st_mtime
;
1671 needle
.name
= file_name
;
1672 if (std::find (names
.begin (), names
.end (), needle
) == names
.end ())
1674 /* Append the non-canonical name. */
1675 names
.push_back (name_map (xstrdup (file_name
), idx
));
1678 /* Resort the name map. */
1679 std::sort (names
.begin (), names
.end ());
1682 if (sources
[idx
].file_time
> bbg_file_time
)
1684 static int info_emitted
;
1686 fnotice (stderr
, "%s:source file is newer than notes file '%s'\n",
1687 file_name
, bbg_file_name
);
1691 "(the message is displayed only once per source file)\n");
1694 sources
[idx
].file_time
= 0;
1700 /* Read the notes file. Save functions to FUNCTIONS global vector. */
1703 read_graph_file (void)
1706 unsigned current_tag
= 0;
1709 if (!gcov_open (bbg_file_name
, 1))
1711 fnotice (stderr
, "%s:cannot open notes file\n", bbg_file_name
);
1714 bbg_file_time
= gcov_time ();
1715 if (!gcov_magic (gcov_read_unsigned (), GCOV_NOTE_MAGIC
))
1717 fnotice (stderr
, "%s:not a gcov notes file\n", bbg_file_name
);
1722 version
= gcov_read_unsigned ();
1723 if (version
!= GCOV_VERSION
)
1727 GCOV_UNSIGNED2STRING (v
, version
);
1728 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
1730 fnotice (stderr
, "%s:version '%.4s', prefer '%.4s'\n",
1731 bbg_file_name
, v
, e
);
1733 bbg_stamp
= gcov_read_unsigned ();
1734 bbg_cwd
= xstrdup (gcov_read_string ());
1735 bbg_supports_has_unexecuted_blocks
= gcov_read_unsigned ();
1737 function_info
*fn
= NULL
;
1738 while ((tag
= gcov_read_unsigned ()))
1740 unsigned length
= gcov_read_unsigned ();
1741 gcov_position_t base
= gcov_position ();
1743 if (tag
== GCOV_TAG_FUNCTION
)
1745 char *function_name
;
1747 unsigned lineno_checksum
, cfg_checksum
;
1749 ident
= gcov_read_unsigned ();
1750 lineno_checksum
= gcov_read_unsigned ();
1751 cfg_checksum
= gcov_read_unsigned ();
1752 function_name
= xstrdup (gcov_read_string ());
1753 unsigned artificial
= gcov_read_unsigned ();
1754 unsigned src_idx
= find_source (gcov_read_string ());
1755 unsigned start_line
= gcov_read_unsigned ();
1756 unsigned start_column
= gcov_read_unsigned ();
1757 unsigned end_line
= gcov_read_unsigned ();
1758 unsigned end_column
= gcov_read_unsigned ();
1760 fn
= new function_info ();
1761 functions
.push_back (fn
);
1762 ident_to_fn
[ident
] = fn
;
1764 fn
->m_name
= function_name
;
1766 fn
->lineno_checksum
= lineno_checksum
;
1767 fn
->cfg_checksum
= cfg_checksum
;
1769 fn
->start_line
= start_line
;
1770 fn
->start_column
= start_column
;
1771 fn
->end_line
= end_line
;
1772 fn
->end_column
= end_column
;
1773 fn
->artificial
= artificial
;
1777 else if (fn
&& tag
== GCOV_TAG_BLOCKS
)
1779 if (!fn
->blocks
.empty ())
1780 fnotice (stderr
, "%s:already seen blocks for '%s'\n",
1781 bbg_file_name
, fn
->get_name ());
1783 fn
->blocks
.resize (gcov_read_unsigned ());
1785 else if (fn
&& tag
== GCOV_TAG_ARCS
)
1787 unsigned src
= gcov_read_unsigned ();
1788 fn
->blocks
[src
].id
= src
;
1789 unsigned num_dests
= GCOV_TAG_ARCS_NUM (length
);
1790 block_info
*src_blk
= &fn
->blocks
[src
];
1791 unsigned mark_catches
= 0;
1792 struct arc_info
*arc
;
1794 if (src
>= fn
->blocks
.size () || fn
->blocks
[src
].succ
)
1799 unsigned dest
= gcov_read_unsigned ();
1800 unsigned flags
= gcov_read_unsigned ();
1802 if (dest
>= fn
->blocks
.size ())
1804 arc
= XCNEW (arc_info
);
1806 arc
->dst
= &fn
->blocks
[dest
];
1810 arc
->count_valid
= 0;
1811 arc
->on_tree
= !!(flags
& GCOV_ARC_ON_TREE
);
1812 arc
->fake
= !!(flags
& GCOV_ARC_FAKE
);
1813 arc
->fall_through
= !!(flags
& GCOV_ARC_FALLTHROUGH
);
1815 arc
->succ_next
= src_blk
->succ
;
1816 src_blk
->succ
= arc
;
1817 src_blk
->num_succ
++;
1819 arc
->pred_next
= fn
->blocks
[dest
].pred
;
1820 fn
->blocks
[dest
].pred
= arc
;
1821 fn
->blocks
[dest
].num_pred
++;
1827 /* Exceptional exit from this function, the
1828 source block must be a call. */
1829 fn
->blocks
[src
].is_call_site
= 1;
1830 arc
->is_call_non_return
= 1;
1835 /* Non-local return from a callee of this
1836 function. The destination block is a setjmp. */
1837 arc
->is_nonlocal_return
= 1;
1838 fn
->blocks
[dest
].is_nonlocal_return
= 1;
1843 fn
->counts
.push_back (0);
1848 /* We have a fake exit from this block. The other
1849 non-fall through exits must be to catch handlers.
1850 Mark them as catch arcs. */
1852 for (arc
= src_blk
->succ
; arc
; arc
= arc
->succ_next
)
1853 if (!arc
->fake
&& !arc
->fall_through
)
1860 else if (fn
&& tag
== GCOV_TAG_LINES
)
1862 unsigned blockno
= gcov_read_unsigned ();
1863 block_info
*block
= &fn
->blocks
[blockno
];
1865 if (blockno
>= fn
->blocks
.size ())
1870 unsigned lineno
= gcov_read_unsigned ();
1873 block
->locations
.back ().lines
.push_back (lineno
);
1876 const char *file_name
= gcov_read_string ();
1880 block
->locations
.push_back (block_location_info
1881 (find_source (file_name
)));
1885 else if (current_tag
&& !GCOV_TAG_IS_SUBTAG (current_tag
, tag
))
1890 gcov_sync (base
, length
);
1891 if (gcov_is_error ())
1894 fnotice (stderr
, "%s:corrupted\n", bbg_file_name
);
1900 if (functions
.empty ())
1901 fnotice (stderr
, "%s:no functions found\n", bbg_file_name
);
1904 /* Reads profiles from the count file and attach to each
1905 function. Return nonzero if fatal error. */
1908 read_count_file (void)
1913 function_info
*fn
= NULL
;
1915 map
<unsigned, function_info
*>::iterator it
;
1917 if (!gcov_open (da_file_name
, 1))
1919 fnotice (stderr
, "%s:cannot open data file, assuming not executed\n",
1924 if (!gcov_magic (gcov_read_unsigned (), GCOV_DATA_MAGIC
))
1926 fnotice (stderr
, "%s:not a gcov data file\n", da_file_name
);
1931 version
= gcov_read_unsigned ();
1932 if (version
!= GCOV_VERSION
)
1936 GCOV_UNSIGNED2STRING (v
, version
);
1937 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
1939 fnotice (stderr
, "%s:version '%.4s', prefer version '%.4s'\n",
1940 da_file_name
, v
, e
);
1942 tag
= gcov_read_unsigned ();
1943 if (tag
!= bbg_stamp
)
1945 fnotice (stderr
, "%s:stamp mismatch with notes file\n", da_file_name
);
1949 while ((tag
= gcov_read_unsigned ()))
1951 unsigned length
= gcov_read_unsigned ();
1952 int read_length
= (int)length
;
1953 unsigned long base
= gcov_position ();
1955 if (tag
== GCOV_TAG_OBJECT_SUMMARY
)
1957 struct gcov_summary summary
;
1958 gcov_read_summary (&summary
);
1959 object_runs
= summary
.runs
;
1961 else if (tag
== GCOV_TAG_FUNCTION
&& !length
)
1963 else if (tag
== GCOV_TAG_FUNCTION
&& length
== GCOV_TAG_FUNCTION_LENGTH
)
1966 ident
= gcov_read_unsigned ();
1968 it
= ident_to_fn
.find (ident
);
1969 if (it
!= ident_to_fn
.end ())
1974 else if (gcov_read_unsigned () != fn
->lineno_checksum
1975 || gcov_read_unsigned () != fn
->cfg_checksum
)
1978 fnotice (stderr
, "%s:profile mismatch for '%s'\n",
1979 da_file_name
, fn
->get_name ());
1983 else if (tag
== GCOV_TAG_FOR_COUNTER (GCOV_COUNTER_ARCS
) && fn
)
1985 length
= abs (read_length
);
1986 if (length
!= GCOV_TAG_COUNTER_LENGTH (fn
->counts
.size ()))
1989 if (read_length
> 0)
1990 for (ix
= 0; ix
!= fn
->counts
.size (); ix
++)
1991 fn
->counts
[ix
] += gcov_read_counter ();
1993 if (read_length
< 0)
1995 gcov_sync (base
, read_length
);
1996 if ((error
= gcov_is_error ()))
2000 ? N_("%s:overflowed\n")
2001 : N_("%s:corrupted\n"),
2011 /* Solve the flow graph. Propagate counts from the instrumented arcs
2012 to the blocks and the uninstrumented arcs. */
2015 solve_flow_graph (function_info
*fn
)
2019 gcov_type
*count_ptr
= &fn
->counts
.front ();
2021 block_info
*valid_blocks
= NULL
; /* valid, but unpropagated blocks. */
2022 block_info
*invalid_blocks
= NULL
; /* invalid, but inferable blocks. */
2024 /* The arcs were built in reverse order. Fix that now. */
2025 for (ix
= fn
->blocks
.size (); ix
--;)
2027 arc_info
*arc_p
, *arc_n
;
2029 for (arc_p
= NULL
, arc
= fn
->blocks
[ix
].succ
; arc
;
2030 arc_p
= arc
, arc
= arc_n
)
2032 arc_n
= arc
->succ_next
;
2033 arc
->succ_next
= arc_p
;
2035 fn
->blocks
[ix
].succ
= arc_p
;
2037 for (arc_p
= NULL
, arc
= fn
->blocks
[ix
].pred
; arc
;
2038 arc_p
= arc
, arc
= arc_n
)
2040 arc_n
= arc
->pred_next
;
2041 arc
->pred_next
= arc_p
;
2043 fn
->blocks
[ix
].pred
= arc_p
;
2046 if (fn
->blocks
.size () < 2)
2047 fnotice (stderr
, "%s:'%s' lacks entry and/or exit blocks\n",
2048 bbg_file_name
, fn
->get_name ());
2051 if (fn
->blocks
[ENTRY_BLOCK
].num_pred
)
2052 fnotice (stderr
, "%s:'%s' has arcs to entry block\n",
2053 bbg_file_name
, fn
->get_name ());
2055 /* We can't deduce the entry block counts from the lack of
2057 fn
->blocks
[ENTRY_BLOCK
].num_pred
= ~(unsigned)0;
2059 if (fn
->blocks
[EXIT_BLOCK
].num_succ
)
2060 fnotice (stderr
, "%s:'%s' has arcs from exit block\n",
2061 bbg_file_name
, fn
->get_name ());
2063 /* Likewise, we can't deduce exit block counts from the lack
2064 of its successors. */
2065 fn
->blocks
[EXIT_BLOCK
].num_succ
= ~(unsigned)0;
2068 /* Propagate the measured counts, this must be done in the same
2069 order as the code in profile.c */
2070 for (unsigned i
= 0; i
< fn
->blocks
.size (); i
++)
2072 blk
= &fn
->blocks
[i
];
2073 block_info
const *prev_dst
= NULL
;
2074 int out_of_order
= 0;
2075 int non_fake_succ
= 0;
2077 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2085 arc
->count
= *count_ptr
++;
2086 arc
->count_valid
= 1;
2088 arc
->dst
->num_pred
--;
2090 if (prev_dst
&& prev_dst
> arc
->dst
)
2092 prev_dst
= arc
->dst
;
2094 if (non_fake_succ
== 1)
2096 /* If there is only one non-fake exit, it is an
2097 unconditional branch. */
2098 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2101 arc
->is_unconditional
= 1;
2102 /* If this block is instrumenting a call, it might be
2103 an artificial block. It is not artificial if it has
2104 a non-fallthrough exit, or the destination of this
2105 arc has more than one entry. Mark the destination
2106 block as a return site, if none of those conditions
2108 if (blk
->is_call_site
&& arc
->fall_through
2109 && arc
->dst
->pred
== arc
&& !arc
->pred_next
)
2110 arc
->dst
->is_call_return
= 1;
2114 /* Sort the successor arcs into ascending dst order. profile.c
2115 normally produces arcs in the right order, but sometimes with
2116 one or two out of order. We're not using a particularly
2120 arc_info
*start
= blk
->succ
;
2121 unsigned changes
= 1;
2125 arc_info
*arc
, *arc_p
, *arc_n
;
2128 for (arc_p
= NULL
, arc
= start
; (arc_n
= arc
->succ_next
);)
2130 if (arc
->dst
> arc_n
->dst
)
2134 arc_p
->succ_next
= arc_n
;
2137 arc
->succ_next
= arc_n
->succ_next
;
2138 arc_n
->succ_next
= arc
;
2151 /* Place it on the invalid chain, it will be ignored if that's
2153 blk
->invalid_chain
= 1;
2154 blk
->chain
= invalid_blocks
;
2155 invalid_blocks
= blk
;
2158 while (invalid_blocks
|| valid_blocks
)
2160 while ((blk
= invalid_blocks
))
2162 gcov_type total
= 0;
2163 const arc_info
*arc
;
2165 invalid_blocks
= blk
->chain
;
2166 blk
->invalid_chain
= 0;
2168 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2169 total
+= arc
->count
;
2170 else if (!blk
->num_pred
)
2171 for (arc
= blk
->pred
; arc
; arc
= arc
->pred_next
)
2172 total
+= arc
->count
;
2177 blk
->count_valid
= 1;
2178 blk
->chain
= valid_blocks
;
2179 blk
->valid_chain
= 1;
2182 while ((blk
= valid_blocks
))
2185 arc_info
*arc
, *inv_arc
;
2187 valid_blocks
= blk
->chain
;
2188 blk
->valid_chain
= 0;
2189 if (blk
->num_succ
== 1)
2195 for (arc
= blk
->succ
; arc
; arc
= arc
->succ_next
)
2197 total
-= arc
->count
;
2198 if (!arc
->count_valid
)
2202 inv_arc
->count_valid
= 1;
2203 inv_arc
->count
= total
;
2206 if (dst
->count_valid
)
2208 if (dst
->num_pred
== 1 && !dst
->valid_chain
)
2210 dst
->chain
= valid_blocks
;
2211 dst
->valid_chain
= 1;
2217 if (!dst
->num_pred
&& !dst
->invalid_chain
)
2219 dst
->chain
= invalid_blocks
;
2220 dst
->invalid_chain
= 1;
2221 invalid_blocks
= dst
;
2225 if (blk
->num_pred
== 1)
2231 for (arc
= blk
->pred
; arc
; arc
= arc
->pred_next
)
2233 total
-= arc
->count
;
2234 if (!arc
->count_valid
)
2238 inv_arc
->count_valid
= 1;
2239 inv_arc
->count
= total
;
2242 if (src
->count_valid
)
2244 if (src
->num_succ
== 1 && !src
->valid_chain
)
2246 src
->chain
= valid_blocks
;
2247 src
->valid_chain
= 1;
2253 if (!src
->num_succ
&& !src
->invalid_chain
)
2255 src
->chain
= invalid_blocks
;
2256 src
->invalid_chain
= 1;
2257 invalid_blocks
= src
;
2264 /* If the graph has been correctly solved, every block will have a
2266 for (unsigned i
= 0; ix
< fn
->blocks
.size (); i
++)
2267 if (!fn
->blocks
[i
].count_valid
)
2269 fnotice (stderr
, "%s:graph is unsolvable for '%s'\n",
2270 bbg_file_name
, fn
->get_name ());
2275 /* Mark all the blocks only reachable via an incoming catch. */
2278 find_exception_blocks (function_info
*fn
)
2281 block_info
**queue
= XALLOCAVEC (block_info
*, fn
->blocks
.size ());
2283 /* First mark all blocks as exceptional. */
2284 for (ix
= fn
->blocks
.size (); ix
--;)
2285 fn
->blocks
[ix
].exceptional
= 1;
2287 /* Now mark all the blocks reachable via non-fake edges */
2288 queue
[0] = &fn
->blocks
[0];
2289 queue
[0]->exceptional
= 0;
2292 block_info
*block
= queue
[--ix
];
2293 const arc_info
*arc
;
2295 for (arc
= block
->succ
; arc
; arc
= arc
->succ_next
)
2296 if (!arc
->fake
&& !arc
->is_throw
&& arc
->dst
->exceptional
)
2298 arc
->dst
->exceptional
= 0;
2299 queue
[ix
++] = arc
->dst
;
2305 /* Increment totals in COVERAGE according to arc ARC. */
2308 add_branch_counts (coverage_info
*coverage
, const arc_info
*arc
)
2310 if (arc
->is_call_non_return
)
2313 if (arc
->src
->count
)
2314 coverage
->calls_executed
++;
2316 else if (!arc
->is_unconditional
)
2318 coverage
->branches
++;
2319 if (arc
->src
->count
)
2320 coverage
->branches_executed
++;
2322 coverage
->branches_taken
++;
2326 /* Format COUNT, if flag_human_readable_numbers is set, return it human
2330 format_count (gcov_type count
)
2332 static char buffer
[64];
2333 const char *units
= " kMGTPEZY";
2335 if (count
< 1000 || !flag_human_readable_numbers
)
2337 sprintf (buffer
, "%" PRId64
, count
);
2342 gcov_type divisor
= 1;
2343 for (i
= 0; units
[i
+1]; i
++, divisor
*= 1000)
2345 if (count
+ divisor
/ 2 < 1000 * divisor
)
2348 float r
= 1.0f
* count
/ divisor
;
2349 sprintf (buffer
, "%.1f%c", r
, units
[i
]);
2353 /* Format a GCOV_TYPE integer as either a percent ratio, or absolute
2354 count. If DECIMAL_PLACES >= 0, format TOP/BOTTOM * 100 to DECIMAL_PLACES.
2355 If DECIMAL_PLACES is zero, no decimal point is printed. Only print 100% when
2356 TOP==BOTTOM and only print 0% when TOP=0. If DECIMAL_PLACES < 0, then simply
2357 format TOP. Return pointer to a static string. */
2360 format_gcov (gcov_type top
, gcov_type bottom
, int decimal_places
)
2362 static char buffer
[20];
2364 if (decimal_places
>= 0)
2366 float ratio
= bottom
? 100.0f
* top
/ bottom
: 0;
2368 /* Round up to 1% if there's a small non-zero value. */
2369 if (ratio
> 0.0f
&& ratio
< 0.5f
&& decimal_places
== 0)
2371 sprintf (buffer
, "%.*f%%", decimal_places
, ratio
);
2374 return format_count (top
);
2379 /* Summary of execution */
2382 executed_summary (unsigned lines
, unsigned executed
)
2385 fnotice (stdout
, "Lines executed:%s of %d\n",
2386 format_gcov (executed
, lines
, 2), lines
);
2388 fnotice (stdout
, "No executable lines\n");
2391 /* Output summary info for a function. */
2394 function_summary (const coverage_info
*coverage
)
2396 fnotice (stdout
, "%s '%s'\n", "Function", coverage
->name
);
2397 executed_summary (coverage
->lines
, coverage
->lines_executed
);
2400 /* Output summary info for a file. */
2403 file_summary (const coverage_info
*coverage
)
2405 fnotice (stdout
, "%s '%s'\n", "File", coverage
->name
);
2406 executed_summary (coverage
->lines
, coverage
->lines_executed
);
2410 if (coverage
->branches
)
2412 fnotice (stdout
, "Branches executed:%s of %d\n",
2413 format_gcov (coverage
->branches_executed
,
2414 coverage
->branches
, 2),
2415 coverage
->branches
);
2416 fnotice (stdout
, "Taken at least once:%s of %d\n",
2417 format_gcov (coverage
->branches_taken
,
2418 coverage
->branches
, 2),
2419 coverage
->branches
);
2422 fnotice (stdout
, "No branches\n");
2423 if (coverage
->calls
)
2424 fnotice (stdout
, "Calls executed:%s of %d\n",
2425 format_gcov (coverage
->calls_executed
, coverage
->calls
, 2),
2428 fnotice (stdout
, "No calls\n");
2432 /* Canonicalize the filename NAME by canonicalizing directory
2433 separators, eliding . components and resolving .. components
2434 appropriately. Always returns a unique string. */
2437 canonicalize_name (const char *name
)
2439 /* The canonical name cannot be longer than the incoming name. */
2440 char *result
= XNEWVEC (char, strlen (name
) + 1);
2441 const char *base
= name
, *probe
;
2446 #if HAVE_DOS_BASED_FILE_SYSTEM
2447 if (base
[0] && base
[1] == ':')
2449 result
[0] = base
[0];
2455 for (dd_base
= ptr
; *base
; base
= probe
)
2459 for (probe
= base
; *probe
; probe
++)
2460 if (IS_DIR_SEPARATOR (*probe
))
2464 if (len
== 1 && base
[0] == '.')
2465 /* Elide a '.' directory */
2467 else if (len
== 2 && base
[0] == '.' && base
[1] == '.')
2469 /* '..', we can only elide it and the previous directory, if
2470 we're not a symlink. */
2471 struct stat ATTRIBUTE_UNUSED buf
;
2475 #if defined (S_ISLNK)
2476 /* S_ISLNK is not POSIX.1-1996. */
2477 || stat (result
, &buf
) || S_ISLNK (buf
.st_mode
)
2481 /* Cannot elide, or unreadable or a symlink. */
2482 dd_base
= ptr
+ 2 + slash
;
2485 while (ptr
!= dd_base
&& *ptr
!= '/')
2487 slash
= ptr
!= result
;
2492 /* Regular pathname component. */
2495 memcpy (ptr
, base
, len
);
2500 for (; IS_DIR_SEPARATOR (*probe
); probe
++)
2508 /* Print hex representation of 16 bytes from SUM and write it to BUFFER. */
2511 md5sum_to_hex (const char *sum
, char *buffer
)
2513 for (unsigned i
= 0; i
< 16; i
++)
2514 sprintf (buffer
+ (2 * i
), "%02x", (unsigned char)sum
[i
]);
2517 /* Generate an output file name. INPUT_NAME is the canonicalized main
2518 input file and SRC_NAME is the canonicalized file name.
2519 LONG_OUTPUT_NAMES and PRESERVE_PATHS affect name generation. With
2520 long_output_names we prepend the processed name of the input file
2521 to each output name (except when the current source file is the
2522 input file, so you don't get a double concatenation). The two
2523 components are separated by '##'. With preserve_paths we create a
2524 filename from all path components of the source file, replacing '/'
2525 with '#', and .. with '^', without it we simply take the basename
2526 component. (Remember, the canonicalized name will already have
2527 elided '.' components and converted \\ separators.) */
2530 make_gcov_file_name (const char *input_name
, const char *src_name
)
2535 if (flag_long_names
&& input_name
&& strcmp (src_name
, input_name
))
2537 /* Generate the input filename part. */
2538 result
= XNEWVEC (char, strlen (input_name
) + strlen (src_name
) + 10);
2541 ptr
= mangle_name (input_name
, ptr
);
2542 ptr
[0] = ptr
[1] = '#';
2547 result
= XNEWVEC (char, strlen (src_name
) + 10);
2551 ptr
= mangle_name (src_name
, ptr
);
2552 strcpy (ptr
, ".gcov");
2554 /* When hashing filenames, we shorten them by only using the filename
2555 component and appending a hash of the full (mangled) pathname. */
2556 if (flag_hash_filenames
)
2560 char md5sum_hex
[33];
2562 md5_init_ctx (&ctx
);
2563 md5_process_bytes (src_name
, strlen (src_name
), &ctx
);
2564 md5_finish_ctx (&ctx
, md5sum
);
2565 md5sum_to_hex (md5sum
, md5sum_hex
);
2568 result
= XNEWVEC (char, strlen (src_name
) + 50);
2570 ptr
= mangle_name (src_name
, ptr
);
2571 ptr
[0] = ptr
[1] = '#';
2573 memcpy (ptr
, md5sum_hex
, 32);
2575 strcpy (ptr
, ".gcov");
2581 /* Mangle BASE name, copy it at the beginning of PTR buffer and
2582 return address of the \0 character of the buffer. */
2585 mangle_name (char const *base
, char *ptr
)
2589 /* Generate the source filename part. */
2590 if (!flag_preserve_paths
)
2591 base
= lbasename (base
);
2593 base
= mangle_path (base
);
2595 len
= strlen (base
);
2596 memcpy (ptr
, base
, len
);
2602 /* Scan through the bb_data for each line in the block, increment
2603 the line number execution count indicated by the execution count of
2604 the appropriate basic block. */
2607 add_line_counts (coverage_info
*coverage
, function_info
*fn
)
2609 bool has_any_line
= false;
2610 /* Scan each basic block. */
2611 for (unsigned ix
= 0; ix
!= fn
->blocks
.size (); ix
++)
2613 line_info
*line
= NULL
;
2614 block_info
*block
= &fn
->blocks
[ix
];
2615 if (block
->count
&& ix
&& ix
+ 1 != fn
->blocks
.size ())
2616 fn
->blocks_executed
++;
2617 for (unsigned i
= 0; i
< block
->locations
.size (); i
++)
2619 unsigned src_idx
= block
->locations
[i
].source_file_idx
;
2620 vector
<unsigned> &lines
= block
->locations
[i
].lines
;
2622 block
->cycle
.arc
= NULL
;
2623 block
->cycle
.ident
= ~0U;
2625 for (unsigned j
= 0; j
< lines
.size (); j
++)
2627 unsigned ln
= lines
[j
];
2629 /* Line belongs to a function that is in a group. */
2630 if (fn
->group_line_p (ln
, src_idx
))
2632 gcc_assert (lines
[j
] - fn
->start_line
< fn
->lines
.size ());
2633 line
= &(fn
->lines
[lines
[j
] - fn
->start_line
]);
2635 if (!block
->exceptional
)
2637 line
->unexceptional
= 1;
2638 if (block
->count
== 0)
2639 line
->has_unexecuted_block
= 1;
2641 line
->count
+= block
->count
;
2645 gcc_assert (ln
< sources
[src_idx
].lines
.size ());
2646 line
= &(sources
[src_idx
].lines
[ln
]);
2651 if (!line
->count
&& block
->count
)
2652 coverage
->lines_executed
++;
2655 if (!block
->exceptional
)
2657 line
->unexceptional
= 1;
2658 if (block
->count
== 0)
2659 line
->has_unexecuted_block
= 1;
2661 line
->count
+= block
->count
;
2665 has_any_line
= true;
2667 if (!ix
|| ix
+ 1 == fn
->blocks
.size ())
2668 /* Entry or exit block. */;
2669 else if (line
!= NULL
)
2671 line
->blocks
.push_back (block
);
2677 for (arc
= block
->succ
; arc
; arc
= arc
->succ_next
)
2678 line
->branches
.push_back (arc
);
2685 fnotice (stderr
, "%s:no lines for '%s'\n", bbg_file_name
,
2689 /* Accumulate info for LINE that belongs to SRC source file. If ADD_COVERAGE
2690 is set to true, update source file summary. */
2692 static void accumulate_line_info (line_info
*line
, source_info
*src
,
2696 for (vector
<arc_info
*>::iterator it
= line
->branches
.begin ();
2697 it
!= line
->branches
.end (); it
++)
2698 add_branch_counts (&src
->coverage
, *it
);
2700 if (!line
->blocks
.empty ())
2702 /* The user expects the line count to be the number of times
2703 a line has been executed. Simply summing the block count
2704 will give an artificially high number. The Right Thing
2705 is to sum the entry counts to the graph of blocks on this
2706 line, then find the elementary cycles of the local graph
2707 and add the transition counts of those cycles. */
2708 gcov_type count
= 0;
2710 /* Cycle detection. */
2711 for (vector
<block_info
*>::iterator it
= line
->blocks
.begin ();
2712 it
!= line
->blocks
.end (); it
++)
2714 for (arc_info
*arc
= (*it
)->pred
; arc
; arc
= arc
->pred_next
)
2715 if (!line
->has_block (arc
->src
))
2716 count
+= arc
->count
;
2717 for (arc_info
*arc
= (*it
)->succ
; arc
; arc
= arc
->succ_next
)
2718 arc
->cs_count
= arc
->count
;
2721 /* Now, add the count of loops entirely on this line. */
2722 count
+= get_cycles_count (*line
);
2723 line
->count
= count
;
2725 if (line
->count
> src
->maximum_count
)
2726 src
->maximum_count
= line
->count
;
2729 if (line
->exists
&& add_coverage
)
2731 src
->coverage
.lines
++;
2733 src
->coverage
.lines_executed
++;
2737 /* Accumulate the line counts of a file. */
2740 accumulate_line_counts (source_info
*src
)
2742 /* First work on group functions. */
2743 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
2744 it
!= src
->functions
.end (); it
++)
2746 function_info
*fn
= *it
;
2748 if (fn
->src
!= src
->index
|| !fn
->is_group
)
2751 for (vector
<line_info
>::iterator it2
= fn
->lines
.begin ();
2752 it2
!= fn
->lines
.end (); it2
++)
2754 line_info
*line
= &(*it2
);
2755 accumulate_line_info (line
, src
, false);
2759 /* Work on global lines that line in source file SRC. */
2760 for (vector
<line_info
>::iterator it
= src
->lines
.begin ();
2761 it
!= src
->lines
.end (); it
++)
2762 accumulate_line_info (&(*it
), src
, true);
2764 /* If not using intermediate mode, sum lines of group functions and
2765 add them to lines that live in a source file. */
2766 if (!flag_json_format
)
2767 for (vector
<function_info
*>::iterator it
= src
->functions
.begin ();
2768 it
!= src
->functions
.end (); it
++)
2770 function_info
*fn
= *it
;
2772 if (fn
->src
!= src
->index
|| !fn
->is_group
)
2775 for (unsigned i
= 0; i
< fn
->lines
.size (); i
++)
2777 line_info
*fn_line
= &fn
->lines
[i
];
2778 if (fn_line
->exists
)
2780 unsigned ln
= fn
->start_line
+ i
;
2781 line_info
*src_line
= &src
->lines
[ln
];
2783 if (!src_line
->exists
)
2784 src
->coverage
.lines
++;
2785 if (!src_line
->count
&& fn_line
->count
)
2786 src
->coverage
.lines_executed
++;
2788 src_line
->count
+= fn_line
->count
;
2789 src_line
->exists
= 1;
2791 if (fn_line
->has_unexecuted_block
)
2792 src_line
->has_unexecuted_block
= 1;
2794 if (fn_line
->unexceptional
)
2795 src_line
->unexceptional
= 1;
2801 /* Output information about ARC number IX. Returns nonzero if
2802 anything is output. */
2805 output_branch_count (FILE *gcov_file
, int ix
, const arc_info
*arc
)
2807 if (arc
->is_call_non_return
)
2809 if (arc
->src
->count
)
2811 fnotice (gcov_file
, "call %2d returned %s\n", ix
,
2812 format_gcov (arc
->src
->count
- arc
->count
,
2813 arc
->src
->count
, -flag_counts
));
2816 fnotice (gcov_file
, "call %2d never executed\n", ix
);
2818 else if (!arc
->is_unconditional
)
2820 if (arc
->src
->count
)
2821 fnotice (gcov_file
, "branch %2d taken %s%s", ix
,
2822 format_gcov (arc
->count
, arc
->src
->count
, -flag_counts
),
2823 arc
->fall_through
? " (fallthrough)"
2824 : arc
->is_throw
? " (throw)" : "");
2826 fnotice (gcov_file
, "branch %2d never executed", ix
);
2829 fnotice (gcov_file
, " (BB %d)", arc
->dst
->id
);
2831 fnotice (gcov_file
, "\n");
2833 else if (flag_unconditional
&& !arc
->dst
->is_call_return
)
2835 if (arc
->src
->count
)
2836 fnotice (gcov_file
, "unconditional %2d taken %s\n", ix
,
2837 format_gcov (arc
->count
, arc
->src
->count
, -flag_counts
));
2839 fnotice (gcov_file
, "unconditional %2d never executed\n", ix
);
2847 read_line (FILE *file
)
2849 static char *string
;
2850 static size_t string_len
;
2857 string
= XNEWVEC (char, string_len
);
2860 while ((ptr
= fgets (string
+ pos
, string_len
- pos
, file
)))
2862 size_t len
= strlen (string
+ pos
);
2864 if (len
&& string
[pos
+ len
- 1] == '\n')
2866 string
[pos
+ len
- 1] = 0;
2870 /* If the file contains NUL characters or an incomplete
2871 last line, which can happen more than once in one run,
2872 we have to avoid doubling the STRING_LEN unnecessarily. */
2873 if (pos
> string_len
/ 2)
2876 string
= XRESIZEVEC (char, string
, string_len
);
2880 return pos
? string
: NULL
;
2883 /* Pad string S with spaces from left to have total width equal to 9. */
2886 pad_count_string (string
&s
)
2889 s
.insert (0, 9 - s
.size (), ' ');
2892 /* Print GCOV line beginning to F stream. If EXISTS is set to true, the
2893 line exists in source file. UNEXCEPTIONAL indicated that it's not in
2894 an exceptional statement. The output is printed for LINE_NUM of given
2895 COUNT of executions. EXCEPTIONAL_STRING and UNEXCEPTIONAL_STRING are
2896 used to indicate non-executed blocks. */
2899 output_line_beginning (FILE *f
, bool exists
, bool unexceptional
,
2900 bool has_unexecuted_block
,
2901 gcov_type count
, unsigned line_num
,
2902 const char *exceptional_string
,
2903 const char *unexceptional_string
,
2904 unsigned int maximum_count
)
2911 s
= format_gcov (count
, 0, -1);
2912 if (has_unexecuted_block
2913 && bbg_supports_has_unexecuted_blocks
)
2915 if (flag_use_colors
)
2917 pad_count_string (s
);
2918 s
.insert (0, SGR_SEQ (COLOR_BG_MAGENTA
2919 COLOR_SEPARATOR COLOR_FG_WHITE
));
2925 pad_count_string (s
);
2929 if (flag_use_colors
)
2932 pad_count_string (s
);
2934 s
.insert (0, SGR_SEQ (COLOR_BG_RED
2935 COLOR_SEPARATOR COLOR_FG_WHITE
));
2937 s
.insert (0, SGR_SEQ (COLOR_BG_CYAN
2938 COLOR_SEPARATOR COLOR_FG_WHITE
));
2943 s
= unexceptional
? unexceptional_string
: exceptional_string
;
2944 pad_count_string (s
);
2951 pad_count_string (s
);
2954 /* Format line number in output. */
2956 sprintf (buffer
, "%5u", line_num
);
2957 string
linestr (buffer
);
2959 if (flag_use_hotness_colors
&& maximum_count
)
2961 if (count
* 2 > maximum_count
) /* > 50%. */
2962 linestr
.insert (0, SGR_SEQ (COLOR_BG_RED
));
2963 else if (count
* 5 > maximum_count
) /* > 20%. */
2964 linestr
.insert (0, SGR_SEQ (COLOR_BG_YELLOW
));
2965 else if (count
* 10 > maximum_count
) /* > 10%. */
2966 linestr
.insert (0, SGR_SEQ (COLOR_BG_GREEN
));
2967 linestr
+= SGR_RESET
;
2970 fprintf (f
, "%s:%s", s
.c_str (), linestr
.c_str ());
2974 print_source_line (FILE *f
, const vector
<const char *> &source_lines
,
2977 gcc_assert (line
>= 1);
2978 gcc_assert (line
<= source_lines
.size ());
2980 fprintf (f
, ":%s\n", source_lines
[line
- 1]);
2983 /* Output line details for LINE and print it to F file. LINE lives on
2987 output_line_details (FILE *f
, const line_info
*line
, unsigned line_num
)
2989 if (flag_all_blocks
)
2995 for (vector
<block_info
*>::const_iterator it
= line
->blocks
.begin ();
2996 it
!= line
->blocks
.end (); it
++)
2998 if (!(*it
)->is_call_return
)
3000 output_line_beginning (f
, line
->exists
,
3001 (*it
)->exceptional
, false,
3002 (*it
)->count
, line_num
,
3003 "%%%%%", "$$$$$", 0);
3004 fprintf (f
, "-block %2d", ix
++);
3006 fprintf (f
, " (BB %u)", (*it
)->id
);
3010 for (arc
= (*it
)->succ
; arc
; arc
= arc
->succ_next
)
3011 jx
+= output_branch_count (f
, jx
, arc
);
3014 else if (flag_branches
)
3019 for (vector
<arc_info
*>::const_iterator it
= line
->branches
.begin ();
3020 it
!= line
->branches
.end (); it
++)
3021 ix
+= output_branch_count (f
, ix
, (*it
));
3025 /* Output detail statistics about function FN to file F. */
3028 output_function_details (FILE *f
, function_info
*fn
)
3033 arc_info
*arc
= fn
->blocks
[EXIT_BLOCK
].pred
;
3034 gcov_type return_count
= fn
->blocks
[EXIT_BLOCK
].count
;
3035 gcov_type called_count
= fn
->blocks
[ENTRY_BLOCK
].count
;
3037 for (; arc
; arc
= arc
->pred_next
)
3039 return_count
-= arc
->count
;
3041 fprintf (f
, "function %s", fn
->get_name ());
3042 fprintf (f
, " called %s",
3043 format_gcov (called_count
, 0, -1));
3044 fprintf (f
, " returned %s",
3045 format_gcov (return_count
, called_count
, 0));
3046 fprintf (f
, " blocks executed %s",
3047 format_gcov (fn
->blocks_executed
, fn
->get_block_count (), 0));
3051 /* Read in the source file one line at a time, and output that line to
3052 the gcov file preceded by its execution count and other
3056 output_lines (FILE *gcov_file
, const source_info
*src
)
3058 #define DEFAULT_LINE_START " -: 0:"
3059 #define FN_SEPARATOR "------------------\n"
3064 /* Print colorization legend. */
3065 if (flag_use_colors
)
3066 fprintf (gcov_file
, "%s",
3067 DEFAULT_LINE_START
"Colorization: profile count: " \
3068 SGR_SEQ (COLOR_BG_CYAN
) "zero coverage (exceptional)" SGR_RESET \
3070 SGR_SEQ (COLOR_BG_RED
) "zero coverage (unexceptional)" SGR_RESET \
3072 SGR_SEQ (COLOR_BG_MAGENTA
) "unexecuted block" SGR_RESET
"\n");
3074 if (flag_use_hotness_colors
)
3075 fprintf (gcov_file
, "%s",
3076 DEFAULT_LINE_START
"Colorization: line numbers: hotness: " \
3077 SGR_SEQ (COLOR_BG_RED
) "> 50%" SGR_RESET
" " \
3078 SGR_SEQ (COLOR_BG_YELLOW
) "> 20%" SGR_RESET
" " \
3079 SGR_SEQ (COLOR_BG_GREEN
) "> 10%" SGR_RESET
"\n");
3081 fprintf (gcov_file
, DEFAULT_LINE_START
"Source:%s\n", src
->coverage
.name
);
3082 if (!multiple_files
)
3084 fprintf (gcov_file
, DEFAULT_LINE_START
"Graph:%s\n", bbg_file_name
);
3085 fprintf (gcov_file
, DEFAULT_LINE_START
"Data:%s\n",
3086 no_data_file
? "-" : da_file_name
);
3087 fprintf (gcov_file
, DEFAULT_LINE_START
"Runs:%u\n", object_runs
);
3090 source_file
= fopen (src
->name
, "r");
3092 fnotice (stderr
, "Cannot open source file %s\n", src
->name
);
3093 else if (src
->file_time
== 0)
3094 fprintf (gcov_file
, DEFAULT_LINE_START
"Source is newer than graph\n");
3096 vector
<const char *> source_lines
;
3098 while ((retval
= read_line (source_file
)) != NULL
)
3099 source_lines
.push_back (xstrdup (retval
));
3101 unsigned line_start_group
= 0;
3102 vector
<function_info
*> *fns
;
3104 for (unsigned line_num
= 1; line_num
<= source_lines
.size (); line_num
++)
3106 if (line_num
>= src
->lines
.size ())
3108 fprintf (gcov_file
, "%9s:%5u", "-", line_num
);
3109 print_source_line (gcov_file
, source_lines
, line_num
);
3113 const line_info
*line
= &src
->lines
[line_num
];
3115 if (line_start_group
== 0)
3117 fns
= src
->get_functions_at_location (line_num
);
3118 if (fns
!= NULL
&& fns
->size () > 1)
3120 /* It's possible to have functions that partially overlap,
3121 thus take the maximum end_line of functions starting
3123 for (unsigned i
= 0; i
< fns
->size (); i
++)
3124 if ((*fns
)[i
]->end_line
> line_start_group
)
3125 line_start_group
= (*fns
)[i
]->end_line
;
3127 else if (fns
!= NULL
&& fns
->size () == 1)
3129 function_info
*fn
= (*fns
)[0];
3130 output_function_details (gcov_file
, fn
);
3134 /* For lines which don't exist in the .bb file, print '-' before
3135 the source line. For lines which exist but were never
3136 executed, print '#####' or '=====' before the source line.
3137 Otherwise, print the execution count before the source line.
3138 There are 16 spaces of indentation added before the source
3139 line so that tabs won't be messed up. */
3140 output_line_beginning (gcov_file
, line
->exists
, line
->unexceptional
,
3141 line
->has_unexecuted_block
, line
->count
,
3142 line_num
, "=====", "#####", src
->maximum_count
);
3144 print_source_line (gcov_file
, source_lines
, line_num
);
3145 output_line_details (gcov_file
, line
, line_num
);
3147 if (line_start_group
== line_num
)
3149 for (vector
<function_info
*>::iterator it
= fns
->begin ();
3150 it
!= fns
->end (); it
++)
3152 function_info
*fn
= *it
;
3153 vector
<line_info
> &lines
= fn
->lines
;
3155 fprintf (gcov_file
, FN_SEPARATOR
);
3157 string fn_name
= fn
->get_name ();
3158 if (flag_use_colors
)
3160 fn_name
.insert (0, SGR_SEQ (COLOR_FG_CYAN
));
3161 fn_name
+= SGR_RESET
;
3164 fprintf (gcov_file
, "%s:\n", fn_name
.c_str ());
3166 output_function_details (gcov_file
, fn
);
3168 /* Print all lines covered by the function. */
3169 for (unsigned i
= 0; i
< lines
.size (); i
++)
3171 line_info
*line
= &lines
[i
];
3172 unsigned l
= fn
->start_line
+ i
;
3174 /* For lines which don't exist in the .bb file, print '-'
3175 before the source line. For lines which exist but
3176 were never executed, print '#####' or '=====' before
3177 the source line. Otherwise, print the execution count
3178 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
,
3182 line
->unexceptional
,
3183 line
->has_unexecuted_block
,
3185 l
, "=====", "#####",
3186 src
->maximum_count
);
3188 print_source_line (gcov_file
, source_lines
, l
);
3189 output_line_details (gcov_file
, line
, l
);
3193 fprintf (gcov_file
, FN_SEPARATOR
);
3194 line_start_group
= 0;
3199 fclose (source_file
);