1 /* Dump a gcov file, for debugging use.
2 Copyright (C) 2002-2020 Free Software Foundation, Inc.
3 Contributed by Nathan Sidwell <nathan@codesourcery.com>
5 Gcov is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3, or (at your option)
10 Gcov is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with Gcov; see the file COPYING3. If not see
17 <http://www.gnu.org/licenses/>. */
21 #include "coretypes.h"
25 #include "diagnostic.h"
31 static void dump_gcov_file (const char *);
32 static void print_prefix (const char *, unsigned, gcov_position_t
);
33 static void print_usage (void);
34 static void print_version (void);
35 static void tag_function (const char *, unsigned, unsigned, unsigned);
36 static void tag_blocks (const char *, unsigned, unsigned, unsigned);
37 static void tag_arcs (const char *, unsigned, unsigned, unsigned);
38 static void tag_lines (const char *, unsigned, unsigned, unsigned);
39 static void tag_counters (const char *, unsigned, unsigned, unsigned);
40 static void tag_summary (const char *, unsigned, unsigned, unsigned);
41 extern int main (int, char **);
43 typedef struct tag_format
47 void (*proc
) (const char *, unsigned, unsigned, unsigned);
50 static int flag_dump_contents
= 0;
51 static int flag_dump_positions
= 0;
52 static int flag_dump_raw
= 0;
54 static const struct option options
[] =
56 { "help", no_argument
, NULL
, 'h' },
57 { "version", no_argument
, NULL
, 'v' },
58 { "long", no_argument
, NULL
, 'l' },
59 { "positions", no_argument
, NULL
, 'o' },
63 #define VALUE_PADDING_PREFIX " "
64 #define VALUE_PREFIX "%2d: "
66 static const tag_format_t tag_table
[] =
70 {0, "COUNTERS", tag_counters
},
71 {GCOV_TAG_FUNCTION
, "FUNCTION", tag_function
},
72 {GCOV_TAG_BLOCKS
, "BLOCKS", tag_blocks
},
73 {GCOV_TAG_ARCS
, "ARCS", tag_arcs
},
74 {GCOV_TAG_LINES
, "LINES", tag_lines
},
75 {GCOV_TAG_OBJECT_SUMMARY
, "OBJECT_SUMMARY", tag_summary
},
80 main (int argc ATTRIBUTE_UNUSED
, char **argv
)
85 p
= argv
[0] + strlen (argv
[0]);
86 while (p
!= argv
[0] && !IS_DIR_SEPARATOR (p
[-1]))
90 xmalloc_set_program_name (progname
);
92 /* Unlock the stdio streams. */
93 unlock_std_streams ();
97 diagnostic_initialize (global_dc
, 0);
99 while ((opt
= getopt_long (argc
, argv
, "hlprvw", options
, NULL
)) != -1)
110 flag_dump_contents
= 1;
113 flag_dump_positions
= 1;
119 fprintf (stderr
, "unknown flag `%c'\n", opt
);
124 dump_gcov_file (argv
[optind
++]);
131 printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
132 printf ("Print coverage file contents\n");
133 printf (" -h, --help Print this help\n");
134 printf (" -l, --long Dump record contents too\n");
135 printf (" -p, --positions Dump record positions\n");
136 printf (" -r, --raw Print content records in raw format\n");
137 printf (" -v, --version Print version number\n");
138 printf ("\nFor bug reporting instructions, please see:\n%s.\n",
145 printf ("gcov-dump %s%s\n", pkgversion_string
, version_string
);
146 printf ("Copyright (C) 2020 Free Software Foundation, Inc.\n");
147 printf ("This is free software; see the source for copying conditions.\n"
148 "There is NO warranty; not even for MERCHANTABILITY or \n"
149 "FITNESS FOR A PARTICULAR PURPOSE.\n\n");
153 print_prefix (const char *filename
, unsigned depth
, gcov_position_t position
)
155 static const char prefix
[] = " ";
157 printf ("%s:", filename
);
158 if (flag_dump_positions
)
159 printf ("%5lu:", (unsigned long) position
);
160 printf ("%.*s", (int) 2 * depth
, prefix
);
164 dump_gcov_file (const char *filename
)
170 if (!gcov_open (filename
, 1))
172 fprintf (stderr
, "%s:cannot open\n", filename
);
178 unsigned magic
= gcov_read_unsigned ();
183 if ((endianness
= gcov_magic (magic
, GCOV_DATA_MAGIC
)))
185 else if ((endianness
= gcov_magic (magic
, GCOV_NOTE_MAGIC
)))
186 is_data_type
= false;
189 printf ("%s:not a gcov file\n", filename
);
193 version
= gcov_read_unsigned ();
194 GCOV_UNSIGNED2STRING (v
, version
);
195 GCOV_UNSIGNED2STRING (m
, magic
);
197 printf ("%s:%s:magic `%.4s':version `%.4s'%s\n", filename
,
198 is_data_type
? "data" : "note",
199 m
, v
, endianness
< 0 ? " (swapped endianness)" : "");
200 if (version
!= GCOV_VERSION
)
204 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
205 printf ("%s:warning:current version is `%.4s'\n", filename
, e
);
211 unsigned stamp
= gcov_read_unsigned ();
213 printf ("%s:stamp %lu\n", filename
, (unsigned long)stamp
);
218 printf ("%s:cwd: %s\n", filename
, gcov_read_string ());
220 /* Support for unexecuted basic blocks. */
221 unsigned support_unexecuted_blocks
= gcov_read_unsigned ();
222 if (!support_unexecuted_blocks
)
223 printf ("%s: has_unexecuted_block is not supported\n", filename
);
228 gcov_position_t base
, position
= gcov_position ();
229 unsigned tag
, length
;
230 tag_format_t
const *format
;
235 tag
= gcov_read_unsigned ();
238 length
= gcov_read_unsigned ();
239 base
= gcov_position ();
240 mask
= GCOV_TAG_MASK (tag
) >> 1;
241 for (tag_depth
= 4; mask
; mask
>>= 8)
243 if ((mask
& 0xff) != 0xff)
245 printf ("%s:tag `%08x' is invalid\n", filename
, tag
);
250 for (format
= tag_table
; format
->name
; format
++)
251 if (format
->tag
== tag
)
253 format
= &tag_table
[GCOV_TAG_IS_COUNTER (tag
) ? 2 : 1];
257 if (depth
&& depth
< tag_depth
)
259 if (!GCOV_TAG_IS_SUBTAG (tags
[depth
- 1], tag
))
260 printf ("%s:tag `%08x' is incorrectly nested\n",
264 tags
[depth
- 1] = tag
;
267 print_prefix (filename
, tag_depth
, position
);
268 printf ("%08x:%4u:%s", tag
, length
, format
->name
);
270 (*format
->proc
) (filename
, tag
, length
, depth
);
273 if (flag_dump_contents
&& format
->proc
)
275 unsigned long actual_length
= gcov_position () - base
;
277 if (actual_length
> length
)
278 printf ("%s:record size mismatch %lu bytes overread\n",
279 filename
, actual_length
- length
);
280 else if (length
> actual_length
)
281 printf ("%s:record size mismatch %lu bytes unread\n",
282 filename
, length
- actual_length
);
284 gcov_sync (base
, length
);
285 if ((error
= gcov_is_error ()))
287 printf (error
< 0 ? "%s:counter overflow at %lu\n" :
288 "%s:read error at %lu\n", filename
,
289 (long unsigned) gcov_position ());
297 tag_function (const char *filename ATTRIBUTE_UNUSED
,
298 unsigned tag ATTRIBUTE_UNUSED
, unsigned length
,
299 unsigned depth ATTRIBUTE_UNUSED
)
301 unsigned long pos
= gcov_position ();
304 printf (" placeholder");
307 printf (" ident=%u", gcov_read_unsigned ());
308 printf (", lineno_checksum=0x%08x", gcov_read_unsigned ());
309 printf (", cfg_checksum=0x%08x", gcov_read_unsigned ());
311 if (gcov_position () - pos
< length
)
315 name
= gcov_read_string ();
316 printf (", `%s'", name
? name
: "NULL");
317 unsigned artificial
= gcov_read_unsigned ();
318 name
= gcov_read_string ();
319 printf (" %s", name
? name
: "NULL");
320 unsigned line_start
= gcov_read_unsigned ();
321 unsigned column_start
= gcov_read_unsigned ();
322 unsigned line_end
= gcov_read_unsigned ();
323 unsigned column_end
= gcov_read_unsigned ();
324 printf (":%u:%u-%u:%u", line_start
, column_start
,
325 line_end
, column_end
);
327 printf (", artificial");
333 tag_blocks (const char *filename ATTRIBUTE_UNUSED
,
334 unsigned tag ATTRIBUTE_UNUSED
, unsigned length ATTRIBUTE_UNUSED
,
335 unsigned depth ATTRIBUTE_UNUSED
)
337 printf (" %u blocks", gcov_read_unsigned ());
341 tag_arcs (const char *filename ATTRIBUTE_UNUSED
,
342 unsigned tag ATTRIBUTE_UNUSED
, unsigned length ATTRIBUTE_UNUSED
,
345 unsigned n_arcs
= GCOV_TAG_ARCS_NUM (length
);
347 printf (" %u arcs", n_arcs
);
348 if (flag_dump_contents
)
351 unsigned blockno
= gcov_read_unsigned ();
353 for (ix
= 0; ix
!= n_arcs
; ix
++)
360 print_prefix (filename
, depth
, gcov_position ());
361 printf (VALUE_PADDING_PREFIX
"block %u:", blockno
);
363 dst
= gcov_read_unsigned ();
364 flags
= gcov_read_unsigned ();
365 printf (" %u:%04x", dst
, flags
);
370 if (flags
& GCOV_ARC_ON_TREE
)
371 printf ("%ctree", c
), c
= ',';
372 if (flags
& GCOV_ARC_FAKE
)
373 printf ("%cfake", c
), c
= ',';
374 if (flags
& GCOV_ARC_FALLTHROUGH
)
375 printf ("%cfall", c
), c
= ',';
383 tag_lines (const char *filename ATTRIBUTE_UNUSED
,
384 unsigned tag ATTRIBUTE_UNUSED
, unsigned length ATTRIBUTE_UNUSED
,
387 if (flag_dump_contents
)
389 unsigned blockno
= gcov_read_unsigned ();
390 char const *sep
= NULL
;
394 gcov_position_t position
= gcov_position ();
395 const char *source
= NULL
;
396 unsigned lineno
= gcov_read_unsigned ();
400 source
= gcov_read_string ();
409 print_prefix (filename
, depth
, position
);
410 printf (VALUE_PADDING_PREFIX
"block %u:", blockno
);
415 printf ("%s%u", sep
, lineno
);
420 printf ("%s`%s'", sep
, source
);
428 tag_counters (const char *filename ATTRIBUTE_UNUSED
,
429 unsigned tag ATTRIBUTE_UNUSED
, unsigned length ATTRIBUTE_UNUSED
,
432 #define DEF_GCOV_COUNTER(COUNTER, NAME, MERGE_FN) NAME,
433 static const char *const counter_names
[] = {
434 #include "gcov-counter.def"
436 #undef DEF_GCOV_COUNTER
437 unsigned n_counts
= GCOV_TAG_COUNTER_NUM (length
);
439 printf (" %s %u counts",
440 counter_names
[GCOV_COUNTER_FOR_TAG (tag
)], n_counts
);
441 if (flag_dump_contents
)
445 for (ix
= 0; ix
!= n_counts
; ix
++)
457 print_prefix (filename
, depth
, gcov_position ());
458 printf (VALUE_PADDING_PREFIX VALUE_PREFIX
, ix
);
461 count
= gcov_read_counter ();
462 printf ("%" PRId64
" ", count
);
468 tag_summary (const char *filename ATTRIBUTE_UNUSED
,
469 unsigned tag ATTRIBUTE_UNUSED
, unsigned length ATTRIBUTE_UNUSED
,
470 unsigned depth ATTRIBUTE_UNUSED
)
472 gcov_summary summary
;
473 gcov_read_summary (&summary
);
474 printf (" runs=%d, sum_max=%" PRId64
,
475 summary
.runs
, summary
.sum_max
);