1 /* Dump a gcov file, for debugging use.
2 Copyright (C) 2002, 2003 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 2, 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 COPYING. If not, write to
17 the Free Software Foundation, 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. */
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 while ((opt = getopt_long (argc, argv, "hlpv", options, NULL)) != -1)
91 flag_dump_contents = 1;
94 flag_dump_positions = 1;
97 fprintf (stderr, "unknown flag `%c'\n", opt);
102 dump_file (argv[optind++]);
109 printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
110 printf ("Print coverage file contents\n");
111 printf (" -h, --help Print this help\n");
112 printf (" -v, --version Print version number\n");
113 printf (" -l, --long Dump record contents too\n");
114 printf (" -p, --positions Dump record positions\n");
121 unsigned version = GCOV_VERSION;
124 for (ix = 4; ix--; version >>= 8)
126 printf ("gcov %.4s (GCC %s)\n", v, version_string);
127 printf ("Copyright (C) 2002 Free Software Foundation, Inc.\n");
128 printf ("This is free software; see the source for copying conditions. There is NO\n\
129 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n");
133 print_prefix (const char *filename, unsigned depth, gcov_position_t position)
135 static const char prefix[] = " ";
137 printf ("%s:", filename);
138 if (flag_dump_positions)
139 printf ("%lu:", (unsigned long) position);
140 printf ("%.*s", (int) depth, prefix);
144 dump_file (const char *filename)
149 if (!gcov_open (filename, 1))
151 fprintf (stderr, "%s:cannot open\n", filename);
157 unsigned magic = gcov_read_unsigned ();
158 unsigned version = gcov_read_unsigned ();
159 const char *type = NULL;
160 char e[4], v[4], m[4];
161 unsigned expected = GCOV_VERSION;
163 int different = version != GCOV_VERSION;
165 if (magic == GCOV_DATA_MAGIC)
167 else if (magic == GCOV_GRAPH_MAGIC)
171 printf ("%s:not a gcov file\n", filename);
175 for (ix = 4; ix--; expected >>= 8, version >>= 8, magic >>= 8)
182 printf ("%s:%s:magic `%.4s':version `%.4s'\n", filename, type, m, v);
184 printf ("%s:warning:current version is `%.4s'\n", filename, e);
189 unsigned stamp = gcov_read_unsigned ();
191 printf ("%s:stamp %lu\n", filename, (unsigned long)stamp);
196 gcov_position_t base, position = gcov_position ();
197 unsigned tag, length;
198 tag_format_t const *format;
203 tag = gcov_read_unsigned ();
206 length = gcov_read_unsigned ();
207 base = gcov_position ();
208 mask = GCOV_TAG_MASK (tag) >> 1;
209 for (tag_depth = 4; mask; mask >>= 8)
211 if ((mask & 0xff) != 0xff)
213 printf ("%s:tag `%08x' is invalid\n", filename, tag);
218 for (format = tag_table; format->name; format++)
219 if (format->tag == tag)
221 format = &tag_table[GCOV_TAG_IS_COUNTER (tag) ? 2 : 1];
225 if (depth && depth < tag_depth)
227 if (!GCOV_TAG_IS_SUBTAG (tags[depth - 1], tag))
228 printf ("%s:tag `%08x' is incorrectly nested\n",
232 tags[depth - 1] = tag;
235 print_prefix (filename, tag_depth, position);
236 printf ("%08x:%4u:%s", tag, length, format->name);
238 (*format->proc) (filename, tag, length);
241 if (flag_dump_contents && format->proc)
243 unsigned long actual_length = gcov_position () - base;
245 if (actual_length > length)
246 printf ("%s:record size mismatch %lu bytes overread\n",
247 filename, actual_length - length);
248 else if (length > actual_length)
249 printf ("%s:record size mismatch %lu bytes unread\n",
250 filename, length - actual_length);
252 gcov_sync (base, length);
253 if ((error = gcov_is_error ()))
255 printf (error < 0 ? "%s:counter overflow at %lu\n" :
256 "%s:read error at %lu\n", filename,
257 (long unsigned) gcov_position ());
262 printf ("%s:early end of file\n", filename);
267 tag_function (const char *filename ATTRIBUTE_UNUSED,
268 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
270 unsigned long pos = gcov_position ();
272 printf (" ident=%u", gcov_read_unsigned ());
273 printf (", checksum=0x%08x", gcov_read_unsigned ());
275 if (gcov_position () - pos < length)
279 name = gcov_read_string ();
280 printf (", `%s'", name ? name : "NULL");
281 name = gcov_read_string ();
282 printf (" %s", name ? name : "NULL");
283 printf (":%u", gcov_read_unsigned ());
288 tag_blocks (const char *filename ATTRIBUTE_UNUSED,
289 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
291 unsigned n_blocks = length / 4;
293 printf (" %u blocks", n_blocks);
295 if (flag_dump_contents)
299 for (ix = 0; ix != n_blocks; ix++)
304 print_prefix (filename, 0, gcov_position ());
305 printf ("\t\t%u", ix);
307 printf (" %04x", gcov_read_unsigned ());
313 tag_arcs (const char *filename ATTRIBUTE_UNUSED,
314 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
316 unsigned n_arcs = (length - 4) / 8;
318 printf (" %u arcs", n_arcs);
319 if (flag_dump_contents)
322 unsigned blockno = gcov_read_unsigned ();
324 for (ix = 0; ix != n_arcs; ix++)
331 print_prefix (filename, 0, gcov_position ());
332 printf ("\tblock %u:", blockno);
334 dst = gcov_read_unsigned ();
335 flags = gcov_read_unsigned ();
336 printf (" %u:%04x", dst, flags);
342 tag_lines (const char *filename ATTRIBUTE_UNUSED,
343 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
345 if (flag_dump_contents)
347 unsigned blockno = gcov_read_unsigned ();
348 char const *sep = NULL;
352 gcov_position_t position = gcov_position ();
353 const char *source = NULL;
354 unsigned lineno = gcov_read_unsigned ();
358 source = gcov_read_string ();
367 print_prefix (filename, 0, position);
368 printf ("\tblock %u:", blockno);
373 printf ("%s%u", sep, lineno);
378 printf ("%s`%s'", sep, source);
386 tag_counters (const char *filename ATTRIBUTE_UNUSED,
387 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
389 static const char *const counter_names[] = GCOV_COUNTER_NAMES;
390 unsigned n_counts = length / 8;
392 printf (" %s %u counts",
393 counter_names[GCOV_COUNTER_FOR_TAG (tag)], n_counts);
394 if (flag_dump_contents)
398 for (ix = 0; ix != n_counts; ix++)
405 print_prefix (filename, 0, gcov_position ());
406 printf ("\t\t%u", ix);
409 count = gcov_read_counter ();
411 printf (HOST_WIDEST_INT_PRINT_DEC, count);
417 tag_summary (const char *filename ATTRIBUTE_UNUSED,
418 unsigned tag ATTRIBUTE_UNUSED, unsigned length ATTRIBUTE_UNUSED)
420 struct gcov_summary summary;
423 gcov_read_summary (&summary);
424 printf (" checksum=0x%08x", summary.checksum);
426 for (ix = 0; ix != GCOV_COUNTERS; ix++)
429 print_prefix (filename, 0, 0);
430 printf ("\t\tcounts=%u, runs=%u",
431 summary.ctrs[ix].num, summary.ctrs[ix].runs);
433 printf (", sum_all=" HOST_WIDEST_INT_PRINT_DEC,
434 (HOST_WIDEST_INT)summary.ctrs[ix].sum_all);
435 printf (", run_max=" HOST_WIDEST_INT_PRINT_DEC,
436 (HOST_WIDEST_INT)summary.ctrs[ix].run_max);
437 printf (", sum_max=" HOST_WIDEST_INT_PRINT_DEC,
438 (HOST_WIDEST_INT)summary.ctrs[ix].sum_max);