Subversion Repositories scarts

/* Gcov.c: prepend line execution counts and branch probabilities to a

   source file.

   Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 1999,

   2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.

   Contributed by James E. Wilson of Cygnus Support.

   Mangled by Bob Manson of Cygnus Support.

   Mangled further by Nathan Sidwell <nathan@codesourcery.com>

Gcov is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2, or (at your option)

any later version.

Gcov is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with Gcov; see the file COPYING.  If not, write to

the Free Software Foundation, 51 Franklin Street, Fifth Floor,

Boston, MA 02110-1301, USA.  */

/* ??? Print a list of the ten blocks with the highest execution counts,

   and list the line numbers corresponding to those blocks.  Also, perhaps

   list the line numbers with the highest execution counts, only printing

   the first if there are several which are all listed in the same block.  */

/* ??? Should have an option to print the number of basic blocks, and the

   percent of them that are covered.  */

/* ??? Does not correctly handle the case where two .bb files refer to

   the same included source file.  For example, if one has a short

   file containing only inline functions, which is then included in

   two other files, then there will be two .bb files which refer to

   the include file, but there is no way to get the total execution

   counts for the included file, can only get execution counts for one

   or the other of the including files. this can be fixed by --ratios

   --long-file-names --preserve-paths and perl.  */

/* Need an option to show individual block counts, and show

   probabilities of fall through arcs.  */

#include "config.h"

#include "system.h"

#include "coretypes.h"

#include "tm.h"

#include "intl.h"

#include "version.h"

#include <getopt.h>

#define IN_GCOV 1

#include "gcov-io.h"

#include "gcov-io.c"

/* The bbg file is generated by -ftest-coverage option. The da file is

   generated by a program compiled with -fprofile-arcs. Their formats

   are documented in gcov-io.h.  */

/* The functions in this file for creating and solution program flow graphs

   are very similar to functions in the gcc source file profile.c.  In

   some places we make use of the knowledge of how profile.c works to

   select particular algorithms here.  */

/* This is the size of the buffer used to read in source file lines.  */

#define STRING_SIZE 200

struct function_info;

struct block_info;

struct source_info;

/* Describes an arc between two basic blocks.  */

typedef struct arc_info

{

  /* source and destination blocks.  */

  struct block_info *src;

  struct block_info *dst;

  /* transition counts.  */

  gcov_type count;

  /* used in cycle search, so that we do not clobber original counts.  */

  gcov_type cs_count;

  unsigned int count_valid : 1;

  unsigned int on_tree : 1;

  unsigned int fake : 1;

  unsigned int fall_through : 1;

  /* Arc is for a function that abnormally returns.  */

  unsigned int is_call_non_return : 1;

  /* Arc is for catch/setjump.  */

  unsigned int is_nonlocal_return : 1;

  /* Is an unconditional branch.  */

  unsigned int is_unconditional : 1;

  /* Loop making arc.  */

  unsigned int cycle : 1;

  /* Next branch on line.  */

  struct arc_info *line_next;

  /* Links to next arc on src and dst lists.  */

  struct arc_info *succ_next;

  struct arc_info *pred_next;

} arc_t;

/* Describes a basic block. Contains lists of arcs to successor and

   predecessor blocks.  */

typedef struct block_info

{

  /* Chain of exit and entry arcs.  */

  arc_t *succ;

  arc_t *pred;

  /* Number of unprocessed exit and entry arcs.  */

  gcov_type num_succ;

  gcov_type num_pred;

  /* Block execution count.  */

  gcov_type count;

  unsigned flags : 13;

  unsigned count_valid : 1;

  unsigned valid_chain : 1;

  unsigned invalid_chain : 1;

  /* Block is a call instrumenting site.  */

  unsigned is_call_site : 1; /* Does the call.  */

  unsigned is_call_return : 1; /* Is the return.  */

  /* Block is a landing pad for longjmp or throw.  */

  unsigned is_nonlocal_return : 1;

  union

  {

    struct

    {

     /* Array of line numbers and source files. source files are

        introduced by a linenumber of zero, the next 'line number' is

        the number of the source file.  Always starts with a source

        file.  */

      unsigned *encoding;

      unsigned num;

    } line; /* Valid until blocks are linked onto lines */

    struct

    {

      /* Single line graph cycle workspace.  Used for all-blocks

         mode.  */

      arc_t *arc;

      unsigned ident;

    } cycle; /* Used in all-blocks mode, after blocks are linked onto

               lines.  */

  } u;

  /* Temporary chain for solving graph, and for chaining blocks on one

     line.  */

  struct block_info *chain;

} block_t;

/* Describes a single function. Contains an array of basic blocks.  */

typedef struct function_info

{

  /* Name of function.  */

  char *name;

  unsigned ident;

  unsigned checksum;

  /* Array of basic blocks.  */

  block_t *blocks;

  unsigned num_blocks;

  unsigned blocks_executed;

  /* Raw arc coverage counts.  */

  gcov_type *counts;

  unsigned num_counts;

  /* First line number.  */

  unsigned line;

  struct source_info *src;

  /* Next function in same source file.  */

  struct function_info *line_next;

  /* Next function.  */

  struct function_info *next;

} function_t;

/* Describes coverage of a file or function.  */

typedef struct coverage_info

{

  int lines;

  int lines_executed;

  int branches;

  int branches_executed;

  int branches_taken;

  int calls;

  int calls_executed;

  char *name;

} coverage_t;

/* Describes a single line of source. Contains a chain of basic blocks

   with code on it.  */

typedef struct line_info

{

  gcov_type count;         /* execution count */

  union

  {

    arc_t *branches;       /* branches from blocks that end on this

                              line. Used for branch-counts when not

                              all-blocks mode.  */

    block_t *blocks;       /* blocks which start on this line.  Used

                              in all-blocks mode.  */

  } u;

  unsigned exists : 1;

} line_t;

/* Describes a file mentioned in the block graph.  Contains an array

   of line info.  */

typedef struct source_info

{

  /* Name of source file.  */

  char *name;

  unsigned index;

  /* Array of line information.  */

  line_t *lines;

  unsigned num_lines;

  coverage_t coverage;

  /* Functions in this source file.  These are in ascending line

     number order.  */

  function_t *functions;

  /* Next source file.  */

  struct source_info *next;

} source_t;

/* Holds a list of function basic block graphs.  */

static function_t *functions;

/* This points to the head of the sourcefile structure list.  */

static source_t *sources;

/* This holds data summary information.  */

static struct gcov_summary object_summary;

static unsigned program_count;

/* Modification time of graph file.  */

static time_t bbg_file_time;

/* Name and file pointer of the input file for the basic block graph.  */

static char *bbg_file_name;

/* Stamp of the bbg file */

static unsigned bbg_stamp;

/* Name and file pointer of the input file for the arc count data.  */

static char *da_file_name;

/* Output branch probabilities.  */

static int flag_branches = 0;

/* Show unconditional branches too.  */

static int flag_unconditional = 0;

/* Output a gcov file if this is true.  This is on by default, and can

   be turned off by the -n option.  */

static int flag_gcov_file = 1;

/* For included files, make the gcov output file name include the name

   of the input source file.  For example, if x.h is included in a.c,

   then the output file name is a.c##x.h.gcov instead of x.h.gcov.  */

static int flag_long_names = 0;

/* Output count information for every basic block, not merely those

   that contain line number information.  */

static int flag_all_blocks = 0;

/* Output summary info for each function.  */

static int flag_function_summary = 0;

/* Object directory file prefix.  This is the directory/file where the

   graph and data files are looked for, if nonzero.  */

static char *object_directory = 0;

/* Preserve all pathname components. Needed when object files and

   source files are in subdirectories. '/' is mangled as '#', '.' is

   elided and '..' mangled to '^'.  */

static int flag_preserve_paths = 0;

/* Output the number of times a branch was taken as opposed to the percentage

   of times it was taken.  */

static int flag_counts = 0;

/* Forward declarations.  */

static void fnotice (FILE *, const char *, ...) ATTRIBUTE_PRINTF_2;

static int process_args (int, char **);

static void print_usage (int) ATTRIBUTE_NORETURN;

static void print_version (void) ATTRIBUTE_NORETURN;

static void process_file (const char *);

static void create_file_names (const char *);

static source_t *find_source (const char *);

static int read_graph_file (void);

static int read_count_file (void);

static void solve_flow_graph (function_t *);

static void add_branch_counts (coverage_t *, const arc_t *);

static void add_line_counts (coverage_t *, function_t *);

static void function_summary (const coverage_t *, const char *);

static const char *format_gcov (gcov_type, gcov_type, int);

static void accumulate_line_counts (source_t *);

static int output_branch_count (FILE *, int, const arc_t *);

static void output_lines (FILE *, const source_t *);

static char *make_gcov_file_name (const char *, const char *);

static void release_structures (void);

extern int main (int, char **);

int

main (int argc, char **argv)

{

  int argno;

  /* Unlock the stdio streams.  */

  unlock_std_streams ();

  gcc_init_libintl ();

  argno = process_args (argc, argv);

  if (optind == argc)

    print_usage (true);

  for (; argno != argc; argno++)

    {

      release_structures ();

      process_file (argv[argno]);

    }

  return 0;

}

static void

fnotice (FILE *file, const char *cmsgid, ...)

{

  va_list ap;

  va_start (ap, cmsgid);

  vfprintf (file, _(cmsgid), ap);

  va_end (ap);

}

/* Print a usage message and exit.  If ERROR_P is nonzero, this is an error,

   otherwise the output of --help.  */

static void

print_usage (int error_p)

{

  FILE *file = error_p ? stderr : stdout;

  int status = error_p ? FATAL_EXIT_CODE : SUCCESS_EXIT_CODE;

  fnotice (file, "Usage: gcov [OPTION]... SOURCEFILE\n\n");

  fnotice (file, "Print code coverage information.\n\n");

  fnotice (file, "  -h, --help                      Print this help, then exit\n");

  fnotice (file, "  -v, --version                   Print version number, then exit\n");

  fnotice (file, "  -a, --all-blocks                Show information for every basic block\n");

  fnotice (file, "  -b, --branch-probabilities      Include branch probabilities in output\n");

  fnotice (file, "  -c, --branch-counts             Given counts of branches taken\n\

                                    rather than percentages\n");

  fnotice (file, "  -n, --no-output                 Do not create an output file\n");

  fnotice (file, "  -l, --long-file-names           Use long output file names for included\n\

                                    source files\n");

  fnotice (file, "  -f, --function-summaries        Output summaries for each function\n");

  fnotice (file, "  -o, --object-directory DIR|FILE Search for object files in DIR or called FILE\n");

  fnotice (file, "  -p, --preserve-paths            Preserve all pathname components\n");

  fnotice (file, "  -u, --unconditional-branches    Show unconditional branch counts too\n");

  fnotice (file, "\nFor bug reporting instructions, please see:\n%s.\n",

           bug_report_url);

  exit (status);

}

/* Print version information and exit.  */

static void

print_version (void)

{

  fnotice (stdout, "gcov (GCC) %s\n", version_string);

  fprintf (stdout, "Copyright %s 2006 Free Software Foundation, Inc.\n",

           _("(C)"));

  fnotice (stdout,

           _("This is free software; see the source for copying conditions.\n"

             "There is NO warranty; not even for MERCHANTABILITY or \n"

             "FITNESS FOR A PARTICULAR PURPOSE.\n\n"));

  exit (SUCCESS_EXIT_CODE);

}

static const struct option options[] =

{

  { "help",                 no_argument,       NULL, 'h' },

  { "version",              no_argument,       NULL, 'v' },

  { "all-blocks",           no_argument,       NULL, 'a' },

  { "branch-probabilities", no_argument,       NULL, 'b' },

  { "branch-counts",        no_argument,       NULL, 'c' },

  { "no-output",            no_argument,       NULL, 'n' },

  { "long-file-names",      no_argument,       NULL, 'l' },

  { "function-summaries",   no_argument,       NULL, 'f' },

  { "preserve-paths",       no_argument,       NULL, 'p' },

  { "object-directory",     required_argument, NULL, 'o' },

  { "object-file",          required_argument, NULL, 'o' },

  { "unconditional-branches", no_argument,     NULL, 'u' },

  { 0, 0, 0, 0 }

};

/* Process args, return index to first non-arg.  */

static int

process_args (int argc, char **argv)

{

  int opt;

  while ((opt = getopt_long (argc, argv, "abcfhlno:puv", options, NULL)) != -1)

    {

      switch (opt)

        {

        case 'a':

          flag_all_blocks = 1;

          break;

        case 'b':

          flag_branches = 1;

          break;

        case 'c':

          flag_counts = 1;

          break;

        case 'f':

          flag_function_summary = 1;

          break;

        case 'h':

          print_usage (false);

          /* print_usage will exit.  */

        case 'l':

          flag_long_names = 1;

          break;

        case 'n':

          flag_gcov_file = 0;

          break;

        case 'o':

          object_directory = optarg;

          break;

        case 'p':

          flag_preserve_paths = 1;

          break;

        case 'u':

          flag_unconditional = 1;

          break;

        case 'v':

          print_version ();

          /* print_version will exit.  */

        default:

          print_usage (true);

          /* print_usage will exit.  */

        }

    }

  return optind;

}

/* Process a single source file.  */

static void

process_file (const char *file_name)

{

  source_t *src;

  function_t *fn;

  create_file_names (file_name);

  if (read_graph_file ())

    return;

  if (!functions)

    {

      fnotice (stderr, "%s:no functions found\n", bbg_file_name);

      return;

    }

  if (read_count_file ())

    return;

  for (fn = functions; fn; fn = fn->next)

    solve_flow_graph (fn);

  for (src = sources; src; src = src->next)

    src->lines = xcalloc (src->num_lines, sizeof (line_t));

  for (fn = functions; fn; fn = fn->next)

    {

      coverage_t coverage;

      memset (&coverage, 0, sizeof (coverage));

      coverage.name = fn->name;

      add_line_counts (flag_function_summary ? &coverage : NULL, fn);

      if (flag_function_summary)

        {

          function_summary (&coverage, "Function");

          fnotice (stdout, "\n");

        }

    }

  for (src = sources; src; src = src->next)

    {

      accumulate_line_counts (src);

      function_summary (&src->coverage, "File");

      if (flag_gcov_file)

        {

          char *gcov_file_name = make_gcov_file_name (file_name, src->name);

          FILE *gcov_file = fopen (gcov_file_name, "w");

          if (gcov_file)

            {

              fnotice (stdout, "%s:creating '%s'\n",

                       src->name, gcov_file_name);

              output_lines (gcov_file, src);

              if (ferror (gcov_file))

                    fnotice (stderr, "%s:error writing output file '%s'\n",

                             src->name, gcov_file_name);

              fclose (gcov_file);

            }

          else

            fnotice (stderr, "%s:could not open output file '%s'\n",

                     src->name, gcov_file_name);

          free (gcov_file_name);

        }

      fnotice (stdout, "\n");

    }

}

/* Release all memory used.  */

static void

release_structures (void)

{

  function_t *fn;

  source_t *src;

  free (bbg_file_name);

  free (da_file_name);

  da_file_name = bbg_file_name = NULL;

  bbg_file_time = 0;

  bbg_stamp = 0;

  while ((src = sources))

    {

      sources = src->next;

      free (src->name);

      free (src->lines);

    }

  while ((fn = functions))

    {

      unsigned ix;

      block_t *block;

      functions = fn->next;

      for (ix = fn->num_blocks, block = fn->blocks; ix--; block++)

        {

          arc_t *arc, *arc_n;

          for (arc = block->succ; arc; arc = arc_n)

            {

              arc_n = arc->succ_next;

              free (arc);

            }

        }

      free (fn->blocks);

      free (fn->counts);

    }

}

/* Generate the names of the graph and data files. If OBJECT_DIRECTORY

   is not specified, these are looked for in the current directory,

   and named from the basename of the FILE_NAME sans extension. If

   OBJECT_DIRECTORY is specified and is a directory, the files are in

   that directory, but named from the basename of the FILE_NAME, sans

   extension. Otherwise OBJECT_DIRECTORY is taken to be the name of

   the object *file*, and the data files are named from that.  */

static void

create_file_names (const char *file_name)

{

  char *cptr;

  char *name;

  int length = strlen (file_name);

  int base;

  if (object_directory && object_directory[0])

    {

      struct stat status;

      length += strlen (object_directory) + 2;

      name = xmalloc (length);

      name[0] = 0;

      base = !stat (object_directory, &status) && S_ISDIR (status.st_mode);

      strcat (name, object_directory);

      if (base && name[strlen (name) - 1] != '/')

        strcat (name, "/");

    }

  else

    {

      name = xmalloc (length + 1);

      name[0] = 0;

      base = 1;

    }

  if (base)

    {

      /* Append source file name.  */

      cptr = strrchr (file_name, '/');

      strcat (name, cptr ? cptr + 1 : file_name);

    }

  /* Remove the extension.  */

  cptr = strrchr (name, '.');

  if (cptr)

    *cptr = 0;

  length = strlen (name);

  bbg_file_name = xmalloc (length + strlen (GCOV_NOTE_SUFFIX) + 1);

  strcpy (bbg_file_name, name);

  strcpy (bbg_file_name + length, GCOV_NOTE_SUFFIX);

  da_file_name = xmalloc (length + strlen (GCOV_DATA_SUFFIX) + 1);

  strcpy (da_file_name, name);

  strcpy (da_file_name + length, GCOV_DATA_SUFFIX);

  return;

}

/* Find or create a source file structure for FILE_NAME. Copies

   FILE_NAME on creation */

static source_t *

find_source (const char *file_name)

{

  source_t *src;

  if (!file_name)

    file_name = "<unknown>";

  for (src = sources; src; src = src->next)

    if (!strcmp (file_name, src->name))

      return src;

  src = xcalloc (1, sizeof (source_t));

  src->name = xstrdup (file_name);

  src->coverage.name = src->name;

  src->index = sources ? sources->index + 1 : 1;

  src->next = sources;

  sources = src;

  return src;

}

/* Read the graph file. Return nonzero on fatal error.  */

static int

read_graph_file (void)

{

  unsigned version;

  unsigned current_tag = 0;

  struct function_info *fn = NULL;

  source_t *src = NULL;

  unsigned ix;

  unsigned tag;

  if (!gcov_open (bbg_file_name, 1))

    {

      fnotice (stderr, "%s:cannot open graph file\n", bbg_file_name);

      return 1;

    }

  bbg_file_time = gcov_time ();