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, gcov_position_t));
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_counters 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;
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 int argc ATTRIBUTE_UNUSED;
81 while ((opt = getopt_long (argc, argv, "hlpv", options, NULL)) != -1)
92 flag_dump_contents = 1;
95 flag_dump_positions = 1;
98 fprintf (stderr, "unknown flag `%c'\n", opt);
103 dump_file (argv[optind++]);
110 printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
111 printf ("Print coverage file contents\n");
112 printf (" -h, --help Print this help\n");
113 printf (" -v, --version Print version number\n");
114 printf (" -l, --long Dump record contents too\n");
115 printf (" -p, --positions Dump record positions\n");
122 unsigned version = GCOV_VERSION;
125 for (ix = 4; ix--; version >>= 8)
127 printf ("gcov %.4s (GCC %s)\n", v, version_string);
128 printf ("Copyright (C) 2002 Free Software Foundation, Inc.\n");
129 printf ("This is free software; see the source for copying conditions. There is NO\n\
130 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n");
134 print_prefix (filename, depth, position)
135 const char *filename;
137 gcov_position_t position;
139 static const char prefix[] = " ";
141 printf ("%s:", filename);
142 if (flag_dump_positions)
143 printf ("%lu:", (unsigned long) position);
144 printf ("%.*s", (int) depth, prefix);
149 const char *filename;
154 if (!gcov_open (filename, 1))
156 fprintf (stderr, "%s:cannot open\n", filename);
162 unsigned magic = gcov_read_unsigned ();
163 unsigned version = gcov_read_unsigned ();
164 const char *type = NULL;
165 char e[4], v[4], m[4];
166 unsigned expected = GCOV_VERSION;
168 int different = version != GCOV_VERSION;
170 if (magic == GCOV_DATA_MAGIC)
172 else if (magic == GCOV_GRAPH_MAGIC)
176 printf ("%s:not a gcov file\n", filename);
180 for (ix = 4; ix--; expected >>= 8, version >>= 8, magic >>= 8)
187 printf ("%s:%s:magic `%.4s':version `%.4s'\n", filename, type, m, v);
189 printf ("%s:warning:current version is `%.4s'\n", filename, e);
194 gcov_position_t base, position = gcov_position ();
195 unsigned tag, length;
196 tag_format_t const *format;
201 tag = gcov_read_unsigned ();
204 length = gcov_read_unsigned ();
205 base = gcov_position ();
206 mask = GCOV_TAG_MASK (tag) >> 1;
207 for (tag_depth = 4; mask; mask >>= 8)
209 if ((mask & 0xff) != 0xff)
211 printf ("%s:tag `%08x' is invalid\n", filename, tag);
216 for (format = tag_table; format->name; format++)
217 if (format->tag == tag)
219 format = &tag_table[GCOV_TAG_IS_COUNTER (tag) ? 2 : 1];
223 if (depth && depth < tag_depth)
225 if (!GCOV_TAG_IS_SUBTAG (tags[depth - 1], tag))
226 printf ("%s:tag `%08x' is incorrectly nested\n",
230 tags[depth - 1] = tag;
233 print_prefix (filename, tag_depth, position);
234 printf ("%08x:%4u:%s", tag, length, format->name);
236 (*format->proc) (filename, tag, length);
239 if (flag_dump_contents && format->proc)
241 unsigned long actual_length = gcov_position () - base;
243 if (actual_length > length)
244 printf ("%s:record size mismatch %lu bytes overread\n",
245 filename, actual_length - length);
246 else if (length > actual_length)
247 printf ("%s:record size mismatch %lu bytes unread\n",
248 filename, length - actual_length);
250 gcov_sync (base, length);
251 if ((error = gcov_is_error ()))
253 printf (error < 0 ? "%s:counter overflow at %lu\n" :
254 "%s:read error at %lu\n", filename,
255 (long unsigned) gcov_position ());
260 printf ("%s:early end of file\n", filename);
265 tag_function (filename, tag, length)
266 const char *filename ATTRIBUTE_UNUSED;
267 unsigned tag ATTRIBUTE_UNUSED;
268 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 (filename, tag, length)
289 const char *filename ATTRIBUTE_UNUSED;
290 unsigned tag ATTRIBUTE_UNUSED;
291 unsigned length ATTRIBUTE_UNUSED;
293 unsigned n_blocks = length / 4;
295 printf (" %u blocks", n_blocks);
297 if (flag_dump_contents)
301 for (ix = 0; ix != n_blocks; ix++)
306 print_prefix (filename, 0, gcov_position ());
307 printf ("\t\t%u", ix);
309 printf (" %04x", gcov_read_unsigned ());
315 tag_arcs (filename, tag, length)
316 const char *filename ATTRIBUTE_UNUSED;
317 unsigned tag ATTRIBUTE_UNUSED;
318 unsigned length ATTRIBUTE_UNUSED;
320 unsigned n_arcs = (length - 4) / 8;
322 printf (" %u arcs", n_arcs);
323 if (flag_dump_contents)
326 unsigned blockno = gcov_read_unsigned ();
328 for (ix = 0; ix != n_arcs; ix++)
335 print_prefix (filename, 0, gcov_position ());
336 printf ("\tblock %u:", blockno);
338 dst = gcov_read_unsigned ();
339 flags = gcov_read_unsigned ();
340 printf (" %u:%04x", dst, flags);
346 tag_lines (filename, tag, length)
347 const char *filename ATTRIBUTE_UNUSED;
348 unsigned tag ATTRIBUTE_UNUSED;
349 unsigned length ATTRIBUTE_UNUSED;
351 if (flag_dump_contents)
353 unsigned blockno = gcov_read_unsigned ();
354 char const *sep = NULL;
358 gcov_position_t position = gcov_position ();
359 const char *source = NULL;
360 unsigned lineno = gcov_read_unsigned ();
364 source = gcov_read_string ();
373 print_prefix (filename, 0, position);
374 printf ("\tblock %u:", blockno);
379 printf ("%s%u", sep, lineno);
384 printf ("%s`%s'", sep, source);
392 tag_counters (filename, tag, length)
393 const char *filename ATTRIBUTE_UNUSED;
394 unsigned tag ATTRIBUTE_UNUSED;
395 unsigned length ATTRIBUTE_UNUSED;
397 static const char *const counter_names[] = GCOV_COUNTER_NAMES;
398 unsigned n_counts = length / 8;
400 printf (" %s %u counts",
401 counter_names[GCOV_COUNTER_FOR_TAG (tag)], n_counts);
402 if (flag_dump_contents)
406 for (ix = 0; ix != n_counts; ix++)
413 print_prefix (filename, 0, gcov_position ());
414 printf ("\t\t%u", ix);
417 count = gcov_read_counter ();
419 printf (HOST_WIDEST_INT_PRINT_DEC, count);
425 tag_summary (filename, tag, length)
426 const char *filename ATTRIBUTE_UNUSED;
427 unsigned tag ATTRIBUTE_UNUSED;
428 unsigned length ATTRIBUTE_UNUSED;
430 struct gcov_summary summary;
433 gcov_read_summary (&summary);
434 printf (" checksum=0x%08x", summary.checksum);
436 for (ix = 0; ix != GCOV_COUNTERS; ix++)
439 print_prefix (filename, 0, 0);
440 printf ("\t\tcounts=%u, runs=%u",
441 summary.ctrs[ix].num, summary.ctrs[ix].runs);
443 printf (", sum_all=" HOST_WIDEST_INT_PRINT_DEC,
444 (HOST_WIDEST_INT)summary.ctrs[ix].sum_all);
445 printf (", run_max=" HOST_WIDEST_INT_PRINT_DEC,
446 (HOST_WIDEST_INT)summary.ctrs[ix].run_max);
447 printf (", sum_max=" HOST_WIDEST_INT_PRINT_DEC,
448 (HOST_WIDEST_INT)summary.ctrs[ix].sum_max);