1 /* Dump a gcov file, for debugging use.
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
3 Free Software Foundation, Inc.
4 Contributed by Nathan Sidwell <nathan@codesourcery.com>
6 Gcov is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
11 Gcov is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Gcov; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
30 static void dump_file (const char *);
31 static void print_prefix (const char *, unsigned, gcov_position_t);
32 static void print_usage (void);
33 static void print_version (void);
34 static void tag_function (const char *, unsigned, unsigned);
35 static void tag_blocks (const char *, unsigned, unsigned);
36 static void tag_arcs (const char *, unsigned, unsigned);
37 static void tag_lines (const char *, unsigned, unsigned);
38 static void tag_counters (const char *, unsigned, unsigned);
39 static void tag_summary (const char *, unsigned, unsigned);
40 extern int main (int, char **);
42 typedef struct tag_format
46 void (*proc) (const char *, unsigned, unsigned);
49 static int flag_dump_contents = 0;
50 static int flag_dump_positions = 0;
52 static const struct option options[] =
54 { "help", no_argument, NULL, 'h' },
55 { "version", no_argument, NULL, 'v' },
56 { "long", no_argument, NULL, 'l' },
57 { "positions", no_argument, NULL, 'o' },
61 static const tag_format_t tag_table[] =
65 {0, "COUNTERS", tag_counters},
66 {GCOV_TAG_FUNCTION, "FUNCTION", tag_function},
67 {GCOV_TAG_BLOCKS, "BLOCKS", tag_blocks},
68 {GCOV_TAG_ARCS, "ARCS", tag_arcs},
69 {GCOV_TAG_LINES, "LINES", tag_lines},
70 {GCOV_TAG_OBJECT_SUMMARY, "OBJECT_SUMMARY", tag_summary},
71 {GCOV_TAG_PROGRAM_SUMMARY, "PROGRAM_SUMMARY", tag_summary},
76 main (int argc ATTRIBUTE_UNUSED, char **argv)
80 /* Unlock the stdio streams. */
81 unlock_std_streams ();
83 while ((opt = getopt_long (argc, argv, "hlpv", options, NULL)) != -1)
94 flag_dump_contents = 1;
97 flag_dump_positions = 1;
100 fprintf (stderr, "unknown flag `%c'\n", opt);
105 dump_file (argv[optind++]);
112 printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
113 printf ("Print coverage file contents\n");
114 printf (" -h, --help Print this help\n");
115 printf (" -v, --version Print version number\n");
116 printf (" -l, --long Dump record contents too\n");
117 printf (" -p, --positions Dump record positions\n");
123 printf ("gcov-dump %s%s\n", pkgversion_string, version_string);
124 printf ("Copyright (C) 2011 Free Software Foundation, Inc.\n");
125 printf ("This is free software; see the source for copying conditions.\n"
126 "There is NO warranty; not even for MERCHANTABILITY or \n"
127 "FITNESS FOR A PARTICULAR PURPOSE.\n\n");
131 print_prefix (const char *filename, unsigned depth, gcov_position_t position)
133 static const char prefix[] = " ";
135 printf ("%s:", filename);
136 if (flag_dump_positions)
137 printf ("%lu:", (unsigned long) position);
138 printf ("%.*s", (int) depth, prefix);
142 dump_file (const char *filename)
147 if (!gcov_open (filename, 1))
149 fprintf (stderr, "%s:cannot open\n", filename);
155 unsigned magic = gcov_read_unsigned ();
157 const char *type = NULL;
161 if ((endianness = gcov_magic (magic, GCOV_DATA_MAGIC)))
163 else if ((endianness = gcov_magic (magic, GCOV_NOTE_MAGIC)))
167 printf ("%s:not a gcov file\n", filename);
171 version = gcov_read_unsigned ();
172 GCOV_UNSIGNED2STRING (v, version);
173 GCOV_UNSIGNED2STRING (m, magic);
175 printf ("%s:%s:magic `%.4s':version `%.4s'%s\n", filename, type,
176 m, v, endianness < 0 ? " (swapped endianness)" : "");
177 if (version != GCOV_VERSION)
181 GCOV_UNSIGNED2STRING (e, GCOV_VERSION);
182 printf ("%s:warning:current version is `%.4s'\n", filename, e);
188 unsigned stamp = gcov_read_unsigned ();
190 printf ("%s:stamp %lu\n", filename, (unsigned long)stamp);
195 gcov_position_t base, position = gcov_position ();
196 unsigned tag, length;
197 tag_format_t const *format;
202 tag = gcov_read_unsigned ();
205 length = gcov_read_unsigned ();
206 base = gcov_position ();
207 mask = GCOV_TAG_MASK (tag) >> 1;
208 for (tag_depth = 4; mask; mask >>= 8)
210 if ((mask & 0xff) != 0xff)
212 printf ("%s:tag `%08x' is invalid\n", filename, tag);
217 for (format = tag_table; format->name; format++)
218 if (format->tag == tag)
220 format = &tag_table[GCOV_TAG_IS_COUNTER (tag) ? 2 : 1];
224 if (depth && depth < tag_depth)
226 if (!GCOV_TAG_IS_SUBTAG (tags[depth - 1], tag))
227 printf ("%s:tag `%08x' is incorrectly nested\n",
231 tags[depth - 1] = tag;
234 print_prefix (filename, tag_depth, position);
235 printf ("%08x:%4u:%s", tag, length, format->name);
237 (*format->proc) (filename, tag, length);
240 if (flag_dump_contents && format->proc)
242 unsigned long actual_length = gcov_position () - base;
244 if (actual_length > length)
245 printf ("%s:record size mismatch %lu bytes overread\n",
246 filename, actual_length - length);
247 else if (length > actual_length)
248 printf ("%s:record size mismatch %lu bytes unread\n",
249 filename, length - actual_length);
251 gcov_sync (base, length);
252 if ((error = gcov_is_error ()))
254 printf (error < 0 ? "%s:counter overflow at %lu\n" :
255 "%s:read error at %lu\n", filename,
256 (long unsigned) gcov_position ());
264 tag_function (const char *filename ATTRIBUTE_UNUSED,
265 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
267 unsigned long pos = gcov_position ();
269 printf (" ident=%u", gcov_read_unsigned ());
270 printf (", lineno_checksum=0x%08x", gcov_read_unsigned ());
271 printf (", cfg_checksum_checksum=0x%08x", gcov_read_unsigned ());
273 if (gcov_position () - pos < length)
277 name = gcov_read_string ();
278 printf (", `%s'", name ? name : "NULL");
279 name = gcov_read_string ();
280 printf (" %s", name ? name : "NULL");
281 printf (":%u", gcov_read_unsigned ());
286 tag_blocks (const char *filename ATTRIBUTE_UNUSED,
287 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
289 unsigned n_blocks = GCOV_TAG_BLOCKS_NUM (length);
291 printf (" %u blocks", n_blocks);
293 if (flag_dump_contents)
297 for (ix = 0; ix != n_blocks; ix++)
302 print_prefix (filename, 0, gcov_position ());
303 printf ("\t\t%u", ix);
305 printf (" %04x", gcov_read_unsigned ());
311 tag_arcs (const char *filename ATTRIBUTE_UNUSED,
312 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
314 unsigned n_arcs = GCOV_TAG_ARCS_NUM (length);
316 printf (" %u arcs", n_arcs);
317 if (flag_dump_contents)
320 unsigned blockno = gcov_read_unsigned ();
322 for (ix = 0; ix != n_arcs; ix++)
329 print_prefix (filename, 0, gcov_position ());
330 printf ("\tblock %u:", blockno);
332 dst = gcov_read_unsigned ();
333 flags = gcov_read_unsigned ();
334 printf (" %u:%04x", dst, flags);
340 tag_lines (const char *filename ATTRIBUTE_UNUSED,
341 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
343 if (flag_dump_contents)
345 unsigned blockno = gcov_read_unsigned ();
346 char const *sep = NULL;
350 gcov_position_t position = gcov_position ();
351 const char *source = NULL;
352 unsigned lineno = gcov_read_unsigned ();
356 source = gcov_read_string ();
365 print_prefix (filename, 0, position);
366 printf ("\tblock %u:", blockno);
371 printf ("%s%u", sep, lineno);
376 printf ("%s`%s'", sep, source);
384 tag_counters (const char *filename ATTRIBUTE_UNUSED,
385 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
387 static const char *const counter_names[] = GCOV_COUNTER_NAMES;
388 unsigned n_counts = GCOV_TAG_COUNTER_NUM (length);
390 printf (" %s %u counts",
391 counter_names[GCOV_COUNTER_FOR_TAG (tag)], n_counts);
392 if (flag_dump_contents)
396 for (ix = 0; ix != n_counts; ix++)
403 print_prefix (filename, 0, gcov_position ());
404 printf ("\t\t%u", ix);
407 count = gcov_read_counter ();
409 printf (HOST_WIDEST_INT_PRINT_DEC, count);
415 tag_summary (const char *filename ATTRIBUTE_UNUSED,
416 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
418 struct gcov_summary summary;
421 gcov_read_summary (&summary);
422 printf (" checksum=0x%08x", summary.checksum);
424 for (ix = 0; ix != GCOV_COUNTERS_SUMMABLE; ix++)
427 print_prefix (filename, 0, 0);
428 printf ("\t\tcounts=%u, runs=%u",
429 summary.ctrs[ix].num, summary.ctrs[ix].runs);
431 printf (", sum_all=" HOST_WIDEST_INT_PRINT_DEC,
432 (HOST_WIDEST_INT)summary.ctrs[ix].sum_all);
433 printf (", run_max=" HOST_WIDEST_INT_PRINT_DEC,
434 (HOST_WIDEST_INT)summary.ctrs[ix].run_max);
435 printf (", sum_max=" HOST_WIDEST_INT_PRINT_DEC,
436 (HOST_WIDEST_INT)summary.ctrs[ix].sum_max);