gcc/gcov-dump.c

   1 /* Dump a gcov file, for debugging use.
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3    Contributed by Nathan Sidwell <nathan@codesourcery.com>
   4
   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)
   8 any later version.
   9
  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.
  14
  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.  */
  19
  20 #include "config.h"
  21 #include "system.h"
  22 #include "coretypes.h"
  23 #include "tm.h"
  24 #include "version.h"
  25 #include <getopt.h>
  26 #define IN_GCOV (-1)
  27 #include "gcov-io.h"
  28 #include "gcov-io.c"
  29
  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_counters PARAMS ((const char *, unsigned, unsigned));
  39 static void tag_summary PARAMS ((const char *, unsigned, unsigned));
  40 extern int main PARAMS ((int, char **));
  41
  42 typedef struct tag_format
  43 {
  44   unsigned tag;
  45   char const *name;
  46   void (*proc) (const char *, unsigned, unsigned);
  47 } tag_format_t;
  48
  49 static int flag_dump_contents = 0;
  50
  51 static const struct option options[] =
  52 {
  53   { "help",                 no_argument,       NULL, 'h' },
  54   { "version",              no_argument,       NULL, 'v' },
  55   { "long",                 no_argument,       NULL, 'l' },
  56 };
  57
  58 static const tag_format_t tag_table[] =
  59 {
  60   {0, "NOP", NULL},
  61   {0, "UNKNOWN", NULL},
  62   {0, "COUNTERS", tag_counters},
  63   {GCOV_TAG_FUNCTION, "FUNCTION", tag_function},
  64   {GCOV_TAG_BLOCKS, "BLOCKS", tag_blocks},
  65   {GCOV_TAG_ARCS, "ARCS", tag_arcs},
  66   {GCOV_TAG_LINES, "LINES", tag_lines},
  67   {GCOV_TAG_OBJECT_SUMMARY, "OBJECT_SUMMARY", tag_summary},
  68   {GCOV_TAG_PROGRAM_SUMMARY, "PROGRAM_SUMMARY", tag_summary},
  69   {0, NULL, NULL}
  70 };
  71
  72 int main (argc, argv)
  73      int argc ATTRIBUTE_UNUSED;
  74      char **argv;
  75 {
  76   int opt;
  77
  78   while ((opt = getopt_long (argc, argv, "hlv", options, NULL)) != -1)
  79     {
  80       switch (opt)
  81         {
  82         case 'h':
  83           print_usage ();
  84           break;
  85         case 'v':
  86           print_version ();
  87           break;
  88         case 'l':
  89           flag_dump_contents = 1;
  90           break;
  91         default:
  92           fprintf (stderr, "unknown flag `%c'\n", opt);
  93         }
  94     }
  95
  96   while (argv[optind])
  97     dump_file (argv[optind++]);
  98   return 0;
  99 }
 100
 101 static void
 102 print_usage ()
 103 {
 104   printf ("Usage: gcov-dump [OPTION] ... gcovfiles\n");
 105   printf ("Print coverage file contents\n");
 106   printf ("  -h, --help           Print this help\n");
 107   printf ("  -v, --version        Print version number\n");
 108   printf ("  -l, --long           Dump record contents too\n");
 109 }
 110
 111 static void
 112 print_version ()
 113 {
 114   char v[4];
 115   unsigned version = GCOV_VERSION;
 116   unsigned ix;
 117
 118   for (ix = 4; ix--; version >>= 8)
 119     v[ix] = version;
 120   printf ("gcov %.4s (GCC %s)\n", v, version_string);
 121   printf ("Copyright (C) 2002 Free Software Foundation, Inc.\n");
 122   printf ("This is free software; see the source for copying conditions.  There is NO\n\
 123 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n");
 124 }
 125
 126 static void
 127 print_prefix (filename, depth)
 128      const char *filename;
 129      unsigned depth;
 130 {
 131   static const char prefix[] = "    ";
 132
 133   printf ("%s:%.*s", filename, (int) depth, prefix);
 134 }
 135
 136 static void
 137 dump_file (filename)
 138      const char *filename;
 139 {
 140   unsigned tags[4];
 141   unsigned depth = 0;
 142
 143   if (!gcov_open (filename, 1))
 144     {
 145       fprintf (stderr, "%s:cannot open\n", filename);
 146       return;
 147     }
 148
 149   /* magic */
 150   {
 151     unsigned magic = gcov_read_unsigned ();
 152     unsigned version = gcov_read_unsigned ();
 153     const char *type = NULL;
 154     char e[4], v[4], m[4];
 155     unsigned expected = GCOV_VERSION;
 156     unsigned ix;
 157     int different = version != GCOV_VERSION;
 158
 159     if (magic == GCOV_DATA_MAGIC)
 160       type = "data";
 161     else if (magic == GCOV_GRAPH_MAGIC)
 162       type = "graph";
 163     else
 164       {
 165         printf ("%s:not a gcov file\n", filename);
 166         gcov_close ();
 167         return;
 168       }
 169     for (ix = 4; ix--; expected >>= 8, version >>= 8, magic >>= 8)
 170       {
 171         e[ix] = expected;
 172         v[ix] = version;
 173         m[ix] = magic;
 174       }
 175
 176     printf ("%s:%s:magic `%.4s':version `%.4s'\n", filename, type, m, v);
 177     if (different)
 178       printf ("%s:warning:current version is `%.4s'\n", filename, e);
 179   }
 180
 181   while (!gcov_is_eof ())
 182     {
 183       unsigned tag = gcov_read_unsigned ();
 184       unsigned length = gcov_read_unsigned ();
 185       unsigned long base = gcov_position ();
 186       tag_format_t const *format;
 187       unsigned tag_depth;
 188       int error;
 189
 190       if (!tag)
 191         tag_depth = depth;
 192       else
 193         {
 194           unsigned mask = GCOV_TAG_MASK (tag) >> 1;
 195
 196           for (tag_depth = 4; mask; mask >>= 8)
 197             {
 198               if ((mask & 0xff) != 0xff)
 199                 {
 200                   printf ("%s:tag `%08x' is invalid\n", filename, tag);
 201                   break;
 202                 }
 203               tag_depth--;
 204             }
 205         }
 206       for (format = tag_table; format->name; format++)
 207         if (format->tag == tag)
 208           goto found;
 209       format = &tag_table[GCOV_TAG_IS_COUNTER (tag) ? 2 : 1];
 210     found:;
 211       if (tag)
 212         {
 213           if (depth && depth < tag_depth)
 214             {
 215               if (!GCOV_TAG_IS_SUBTAG (tags[depth - 1], tag))
 216                 printf ("%s:tag `%08x' is incorrectly nested\n",
 217                         filename, tag);
 218             }
 219           depth = tag_depth;
 220           tags[depth - 1] = tag;
 221         }
 222
 223       print_prefix (filename, tag_depth);
 224       printf ("%08x:%4u:%s", tag, length, format->name);
 225       if (format->proc)
 226         (*format->proc) (filename, tag, length);
 227
 228       printf ("\n");
 229       if (flag_dump_contents && format->proc)
 230         {
 231           unsigned long actual_length = gcov_position () - base;
 232
 233           if (actual_length > length)
 234             printf ("%s:record size mismatch %lu bytes overread\n",
 235                     filename, actual_length - length);
 236           else if (length > actual_length)
 237             printf ("%s:record size mismatch %lu bytes unread\n",
 238                     filename, length - actual_length);
 239         }
 240       gcov_seek (base, length);
 241       if ((error = gcov_is_error ()))
 242         {
 243           printf (error < 0 ? "%s:counter overflow at %lu\n" :
 244                   "%s:read error at %lu\n", filename, gcov_position ());
 245           break;
 246         }
 247     }
 248   gcov_close ();
 249 }
 250
 251 static void
 252 tag_function (filename, tag, length)
 253      const char *filename ATTRIBUTE_UNUSED;
 254      unsigned tag ATTRIBUTE_UNUSED;
 255      unsigned length ATTRIBUTE_UNUSED;
 256 {
 257   unsigned long pos = gcov_position ();
 258
 259   printf (" ident=%u", gcov_read_unsigned ());
 260   printf (", checksum=0x%08x", gcov_read_unsigned ());
 261
 262   if (gcov_position () - pos < length)
 263     {
 264       const char *name;
 265
 266       name = gcov_read_string ();
 267       printf (", `%s'", name ? name : "NULL");
 268       name = gcov_read_string ();
 269       printf (" %s", name ? name : "NULL");
 270       printf (":%u", gcov_read_unsigned ());
 271     }
 272 }
 273
 274 static void
 275 tag_blocks (filename, tag, length)
 276      const char *filename ATTRIBUTE_UNUSED;
 277      unsigned tag ATTRIBUTE_UNUSED;
 278      unsigned length ATTRIBUTE_UNUSED;
 279 {
 280   unsigned n_blocks = length / 4;
 281
 282   printf (" %u blocks", n_blocks);
 283
 284   if (flag_dump_contents)
 285     {
 286       unsigned ix;
 287
 288       for (ix = 0; ix != n_blocks; ix++)
 289         {
 290           if (!(ix & 7))
 291             printf ("\n%s:\t\t%u", filename, ix);
 292           printf (" %04x", gcov_read_unsigned ());
 293         }
 294     }
 295 }
 296
 297 static void
 298 tag_arcs (filename, tag, length)
 299      const char *filename ATTRIBUTE_UNUSED;
 300      unsigned tag ATTRIBUTE_UNUSED;
 301      unsigned length ATTRIBUTE_UNUSED;
 302 {
 303   unsigned n_arcs = (length - 4) / 8;
 304
 305   printf (" %u arcs", n_arcs);
 306   if (flag_dump_contents)
 307     {
 308       unsigned ix;
 309       unsigned blockno = gcov_read_unsigned ();
 310
 311       for (ix = 0; ix != n_arcs; ix++)
 312         {
 313           unsigned dst = gcov_read_unsigned ();
 314           unsigned flags = gcov_read_unsigned ();
 315
 316           if (!(ix & 3))
 317             printf ("\n%s:\tblock %u:", filename, blockno);
 318           printf (" %u:%04x", dst, flags);
 319         }
 320     }
 321 }
 322
 323 static void
 324 tag_lines (filename, tag, length)
 325      const char *filename ATTRIBUTE_UNUSED;
 326      unsigned tag ATTRIBUTE_UNUSED;
 327      unsigned length ATTRIBUTE_UNUSED;
 328 {
 329   if (flag_dump_contents)
 330     {
 331       unsigned blockno = gcov_read_unsigned ();
 332       char const *sep = NULL;
 333
 334       while (1)
 335         {
 336           const char *source = NULL;
 337           unsigned lineno = gcov_read_unsigned ();
 338
 339           if (!lineno)
 340             {
 341               source = gcov_read_string ();
 342               if (!source)
 343                 break;
 344               sep = NULL;
 345             }
 346
 347           if (!sep)
 348             {
 349               printf ("\n%s:\tblock %u:", filename, blockno);
 350               sep = "";
 351             }
 352           if (lineno)
 353             {
 354               printf ("%s%u", sep, lineno);
 355               sep = ", ";
 356             }
 357           else
 358             {
 359               printf ("%s`%s'", sep, source);
 360               sep = ":";
 361             }
 362         }
 363     }
 364 }
 365
 366 static void
 367 tag_counters (filename, tag, length)
 368      const char *filename ATTRIBUTE_UNUSED;
 369      unsigned tag ATTRIBUTE_UNUSED;
 370      unsigned length ATTRIBUTE_UNUSED;
 371 {
 372   static const char *const counter_names[] = GCOV_COUNTER_NAMES;
 373   unsigned n_counts = length / 8;
 374
 375   printf (" %s %u counts",
 376           counter_names[GCOV_COUNTER_FOR_TAG (tag)], n_counts);
 377   if (flag_dump_contents)
 378     {
 379       unsigned ix;
 380
 381       for (ix = 0; ix != n_counts; ix++)
 382         {
 383           gcov_type count = gcov_read_counter ();
 384
 385           if (!(ix & 7))
 386             printf ("\n%s:\t\t%u", filename, ix);
 387           printf (" ");
 388           printf (HOST_WIDEST_INT_PRINT_DEC, count);
 389         }
 390     }
 391 }
 392
 393 static void
 394 tag_summary (filename, tag, length)
 395      const char *filename ATTRIBUTE_UNUSED;
 396      unsigned tag ATTRIBUTE_UNUSED;
 397      unsigned length ATTRIBUTE_UNUSED;
 398 {
 399   struct gcov_summary summary;
 400   unsigned ix;
 401
 402   gcov_read_summary (&summary);
 403   printf (" checksum=0x%08x", summary.checksum);
 404
 405   for (ix = 0; ix != GCOV_COUNTERS; ix++)
 406     {
 407       printf ("\n%sL\t\tcounts=%u, runs=%u", filename,
 408               summary.ctrs[ix].num, summary.ctrs[ix].runs);
 409
 410       printf (", sum_all=" HOST_WIDEST_INT_PRINT_DEC,
 411               (HOST_WIDEST_INT)summary.ctrs[ix].sum_all);
 412       printf (", run_max=" HOST_WIDEST_INT_PRINT_DEC,
 413               (HOST_WIDEST_INT)summary.ctrs[ix].run_max);
 414       printf (", sum_max=" HOST_WIDEST_INT_PRINT_DEC,
 415               (HOST_WIDEST_INT)summary.ctrs[ix].sum_max);
 416     }
 417 }