1 /* Dump a gcov file, for debugging use.
2 Copyright (C) 2002 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 PARAMS ((const char *));
31 static void print_prefix PARAMS ((const char *, unsigned));
32 static void print_usage PARAMS ((void));
33 static void print_version PARAMS ((void));
34 static void tag_function PARAMS ((const char *, unsigned, unsigned));
35 static void tag_blocks PARAMS ((const char *, unsigned, unsigned));
36 static void tag_arcs PARAMS ((const char *, unsigned, unsigned));
37 static void tag_lines PARAMS ((const char *, unsigned, unsigned));
38 static void tag_arc_counts PARAMS ((const char *, unsigned, unsigned));
39 static void tag_summary PARAMS ((const char *, unsigned, unsigned));
40 extern int main PARAMS ((int, char **));
42 typedef struct tag_format
46 void (*proc) (const char *, unsigned, unsigned);
49 static int flag_dump_contents = 0;
51 static const struct option options[] =
53 { "help", no_argument, NULL, 'h' },
54 { "version", no_argument, NULL, 'v' },
55 { "long", no_argument, NULL, 'l' },
58 static const tag_format_t tag_table[] =
62 {GCOV_TAG_FUNCTION, "FUNCTION", tag_function},
63 {GCOV_TAG_BLOCKS, "BLOCKS", tag_blocks},
64 {GCOV_TAG_ARCS, "ARCS", tag_arcs},
65 {GCOV_TAG_LINES, "LINES", tag_lines},
66 {GCOV_TAG_ARC_COUNTS, "ARC_COUNTS", tag_arc_counts},
67 {GCOV_TAG_OBJECT_SUMMARY, "OBJECT_SUMMARY", tag_summary},
68 {GCOV_TAG_PROGRAM_SUMMARY, "PROGRAM_SUMMARY", tag_summary},
69 {GCOV_TAG_PLACEHOLDER_SUMMARY, "PROGRAM_PLACEHOLDER", tag_summary},
70 {GCOV_TAG_INCORRECT_SUMMARY, "PROGRAM_INCORRECT", tag_summary},
75 int argc ATTRIBUTE_UNUSED;
80 while ((opt = getopt_long (argc, argv, "hlv", options, NULL)) != -1)
91 flag_dump_contents = 1;
94 fprintf (stderr, "unknown flag `%c'\n", opt);
99 dump_file (argv[optind++]);
106 printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
107 printf ("Print coverage file contents\n");
108 printf (" -h, --help Print this help\n");
109 printf (" -v, --version Print version number\n");
110 printf (" -l, --long Dump record contents too\n");
117 unsigned version = GCOV_VERSION;
120 for (ix = 4; ix--; version >>= 8)
122 printf ("gcov %.4s (GCC %s)\n", v, version_string);
123 printf ("Copyright (C) 2002 Free Software Foundation, Inc.\n");
124 printf ("This is free software; see the source for copying conditions. There is NO\n\
125 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n");
129 print_prefix (filename, depth)
130 const char *filename;
133 static const char prefix[] = " ";
135 printf ("%s:%.*s", filename, (int) depth, prefix);
140 const char *filename;
145 if (!gcov_open (filename, 1))
147 fprintf (stderr, "%s:cannot open\n", filename);
153 unsigned magic = gcov_read_unsigned ();
154 unsigned version = gcov_read_unsigned ();
155 const char *type = NULL;
156 char e[4], v[4], m[4];
157 unsigned expected = GCOV_VERSION;
159 int different = version != GCOV_VERSION;
161 if (magic == GCOV_DATA_MAGIC)
163 else if (magic == GCOV_GRAPH_MAGIC)
167 printf ("%s:not a gcov file\n", filename);
171 for (ix = 4; ix--; expected >>= 8, version >>= 8, magic >>= 8)
178 printf ("%s:%s:magic `%.4s':version `%.4s'\n", filename, type, m, v);
180 printf ("%s:warning:current version is `%.4s'\n", filename, e);
183 while (!gcov_is_eof ())
185 unsigned tag = gcov_read_unsigned ();
186 unsigned length = gcov_read_unsigned ();
187 unsigned long base = gcov_position ();
188 tag_format_t const *format;
196 unsigned mask = GCOV_TAG_MASK (tag) >> 1;
198 for (tag_depth = 4; mask; mask >>= 8)
200 if ((mask & 0xff) != 0xff)
202 printf ("%s:tag `%08x' is invalid\n", filename, tag);
208 for (format = tag_table; format->name; format++)
209 if (format->tag == tag)
211 format = &tag_table[1];
215 if (depth && depth < tag_depth)
217 if (!GCOV_TAG_IS_SUBTAG (tags[depth - 1], tag))
218 printf ("%s:tag `%08x' is incorrectly nested\n",
222 tags[depth - 1] = tag;
225 print_prefix (filename, tag_depth);
226 printf ("%08x:%4u:%s", tag, length, format->name);
228 (*format->proc) (filename, tag, length);
231 if (flag_dump_contents && format->proc)
233 unsigned long actual_length = gcov_position () - base;
235 if (actual_length > length)
236 printf ("%s:record size mismatch %lu bytes overread\n",
237 filename, actual_length - length);
238 else if (length > actual_length)
239 printf ("%s:record size mismatch %lu bytes unread\n",
240 filename, length - actual_length);
242 gcov_seek (base, length);
243 if ((error = gcov_is_error ()))
245 printf (error < 0 ? "%s:counter overflow at %lu\n" :
246 "%s:read error at %lu\n", filename, gcov_position ());
254 tag_function (filename, tag, length)
255 const char *filename ATTRIBUTE_UNUSED;
256 unsigned tag ATTRIBUTE_UNUSED;
257 unsigned length ATTRIBUTE_UNUSED;
260 unsigned long pos = gcov_position ();
262 name = gcov_read_string ();
263 printf (" `%s'", name ? name : "NULL");
264 printf (" checksum=0x%08x", gcov_read_unsigned ());
266 if (gcov_position () - pos < length)
268 name = gcov_read_string ();
269 printf (" %s", name ? name : "NULL");
270 printf (":%u", gcov_read_unsigned ());
275 tag_blocks (filename, tag, length)
276 const char *filename ATTRIBUTE_UNUSED;
277 unsigned tag ATTRIBUTE_UNUSED;
278 unsigned length ATTRIBUTE_UNUSED;
280 unsigned n_blocks = length / 4;
282 printf (" %u blocks", n_blocks);
284 if (flag_dump_contents)
288 for (ix = 0; ix != n_blocks; ix++)
291 printf ("\n%s:\t\t%u", filename, ix);
292 printf (" %04x", gcov_read_unsigned ());
298 tag_arcs (filename, tag, length)
299 const char *filename ATTRIBUTE_UNUSED;
300 unsigned tag ATTRIBUTE_UNUSED;
301 unsigned length ATTRIBUTE_UNUSED;
303 unsigned n_arcs = (length - 4) / 8;
305 printf (" %u arcs", n_arcs);
306 if (flag_dump_contents)
309 unsigned blockno = gcov_read_unsigned ();
311 for (ix = 0; ix != n_arcs; ix++)
313 unsigned dst = gcov_read_unsigned ();
314 unsigned flags = gcov_read_unsigned ();
317 printf ("\n%s:\tblock %u:", filename, blockno);
318 printf (" %u:%04x", dst, flags);
324 tag_lines (filename, tag, length)
325 const char *filename ATTRIBUTE_UNUSED;
326 unsigned tag ATTRIBUTE_UNUSED;
327 unsigned length ATTRIBUTE_UNUSED;
329 if (flag_dump_contents)
331 unsigned blockno = gcov_read_unsigned ();
332 char const *sep = NULL;
336 const char *source = NULL;
337 unsigned lineno = gcov_read_unsigned ();
341 source = gcov_read_string ();
349 printf ("\n%s:\tblock %u:", filename, blockno);
354 printf ("%s%u", sep, lineno);
359 printf ("%s`%s'", sep, source);
367 tag_arc_counts (filename, tag, length)
368 const char *filename ATTRIBUTE_UNUSED;
369 unsigned tag ATTRIBUTE_UNUSED;
370 unsigned length ATTRIBUTE_UNUSED;
372 unsigned n_counts = length / 8;
374 printf (" %u counts", n_counts);
375 if (flag_dump_contents)
379 for (ix = 0; ix != n_counts; ix++)
381 gcov_type count = gcov_read_counter ();
384 printf ("\n%s:\t\t%u", filename, ix);
386 printf (HOST_WIDEST_INT_PRINT_DEC, count);
392 tag_summary (filename, tag, length)
393 const char *filename ATTRIBUTE_UNUSED;
394 unsigned tag ATTRIBUTE_UNUSED;
395 unsigned length ATTRIBUTE_UNUSED;
397 struct gcov_summary summary;
399 gcov_read_summary (&summary);
401 printf (" checksum=0x%08x", summary.checksum);
403 printf ("\n%s:\t\truns=%u, arcs=%u", filename,
404 summary.runs, summary.arcs);
405 printf ("\n%s:\t\tarc_sum=", filename);
406 printf (HOST_WIDEST_INT_PRINT_DEC,
407 (HOST_WIDEST_INT)summary.arc_sum);
408 printf (", arc_max_one=");
409 printf (HOST_WIDEST_INT_PRINT_DEC,
410 (HOST_WIDEST_INT)summary.arc_max_one);
411 printf (", sum_max=");
412 printf (HOST_WIDEST_INT_PRINT_DEC,
413 (HOST_WIDEST_INT)summary.arc_sum_max);