Subversion Repositories openrisc

/* 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, 2007, 2008, 2009, 2010, 2011, 2012

   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 3, 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 COPYING3.  If not see

<http://www.gnu.org/licenses/>.  */

/* ??? 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.  */

/* 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 "diagnostic.h"

#include "version.h"

#include <getopt.h>

#define IN_GCOV 1

#include "gcov-io.h"

#include "gcov-io.c"

/* The gcno file is generated by -ftest-coverage option. The gcda 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.  */

/* The code validates that the profile information read in corresponds

   to the code currently being compiled.  Rather than checking for

   identical files, the code below computes a checksum on the CFG

   (based on the order of basic blocks and the arcs in the CFG).  If

   the CFG checksum in the gcda file match the CFG checksum for the

   code currently being compiled, the profile data will be used.  */

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

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 to a catch handler.  */

  unsigned int is_throw : 1;

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

  unsigned int is_call_non_return : 1;

  /* Arc is for catch/setjmp.  */

  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 : 12;

  unsigned count_valid : 1;

  unsigned valid_chain : 1;

  unsigned invalid_chain : 1;

  unsigned exceptional : 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 lineno_checksum;

  unsigned cfg_checksum;

  /* The graph contains at least one fake incoming edge.  */

  unsigned has_catch : 1;

  /* 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 & file.  */

  unsigned line;

  unsigned 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;

  unsigned unexceptional : 1;

} line_t;

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

   of line info.  */

typedef struct source_info

{

  /* Canonical name of source file.  */

  char *name;

  time_t file_time;

  /* 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;

} source_t;

typedef struct name_map

{

  char *name;  /* Source file name */

  unsigned src;  /* Source file */

} name_map_t;

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

static function_t *functions;

static function_t **fn_end = &functions;

static source_t *sources;   /* Array of source files  */

static unsigned n_sources;  /* Number of sources */

static unsigned a_sources;  /* Allocated sources */

static name_map_t *names;   /* Mapping of file names to sources */

static unsigned n_names;    /* Number of names */

static unsigned a_names;    /* Allocated names */

/* This holds data summary information.  */

static unsigned object_runs;

static unsigned program_count;

static unsigned total_lines;

static unsigned total_executed;

/* 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;

/* Data file is missing.  */

static int no_data_file;

/* If there is several input files, compute and display results after

   reading all data files.  This way if two or more gcda file refer to

   the same source file (eg inline subprograms in a .h file), the

   counts are added.  */

static int multiple_files = 0;

/* 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;

/* Output progress indication if this is true.  This is off by default

   and can be turned on by the -d option.  */

static int flag_display_progress = 0;

/* 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;

/* Source directory prefix.  This is removed from source pathnames

   that match, when generating the output file name.  */

static char *source_prefix = 0;

static size_t source_length = 0;

/* Only show data for sources with relative pathnames.  Absolute ones

   usually indicate a system header file, which although it may

   contain inline functions, is usually uninteresting.  */

static int flag_relative_only = 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 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 generate_results (const char *);

static void create_file_names (const char *);

static int name_search (const void *, const void *);

static int name_sort (const void *, const void *);

static char *canonicalize_name (const char *);

static unsigned find_source (const char *);

static function_t *read_graph_file (void);

static int read_count_file (function_t *);

static void solve_flow_graph (function_t *);

static void find_exception_blocks (function_t *);

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

static void add_line_counts (coverage_t *, function_t *);

static void executed_summary (unsigned, unsigned);

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 char *mangle_name (const char *, char *);

static void release_structures (void);

static void release_function (function_t *);

extern int main (int, char **);

int

main (int argc, char **argv)

{

  int argno;

  int first_arg;

  const char *p;

  p = argv[0] + strlen (argv[0]);

  while (p != argv[0] && !IS_DIR_SEPARATOR (p[-1]))

    --p;

  progname = p;

  xmalloc_set_program_name (progname);

  /* Unlock the stdio streams.  */

  unlock_std_streams ();

  gcc_init_libintl ();

  diagnostic_initialize (global_dc, 0);

  /* Handle response files.  */

  expandargv (&argc, &argv);

  a_names = 10;

  names = XNEWVEC (name_map_t, a_names);

  a_sources = 10;

  sources = XNEWVEC (source_t, a_sources);

  argno = process_args (argc, argv);

  if (optind == argc)

    print_usage (true);

  if (argc - argno > 1)

    multiple_files = 1;

  first_arg = argno;

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

    {

      if (flag_display_progress)

        printf("Processing file %d out of %d\n",

               argno - first_arg + 1, argc - first_arg);

      process_file (argv[argno]);

    }

  generate_results (multiple_files ? NULL : argv[argc - 1]);

  release_structures ();

  return 0;

}

/* 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]... SOURCE|OBJ...\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, "  -s, --source-prefix DIR         Source prefix to elide\n");

  fnotice (file, "  -r, --relative-only             Only show data for relative sources\n");

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

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

  fnotice (file, "  -d, --display-progress          Display progress information\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 %s%s\n", pkgversion_string, version_string);

  fprintf (stdout, "Copyright %s 2012 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' },

  { "relative-only",        no_argument,       NULL, 'r' },

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

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

  { "source-prefix",        required_argument, NULL, 's' },

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

  { "display-progress",     no_argument,       NULL, 'd' },

  { 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, "abcdfhlno:s:pruv", 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 's':

          source_prefix = optarg;

          source_length = strlen (source_prefix);

          break;

        case 'r':

          flag_relative_only = 1;

          break;

        case 'p':

          flag_preserve_paths = 1;

          break;

        case 'u':

          flag_unconditional = 1;

          break;

        case 'd':

          flag_display_progress = 1;

          break;

        case 'v':

          print_version ();

          /* print_version will exit.  */

        default:

          print_usage (true);

          /* print_usage will exit.  */

        }

    }

  return optind;

}

/* Process a single input file.  */

static void

process_file (const char *file_name)

{

  function_t *fns;

  create_file_names (file_name);

  fns = read_graph_file ();

  if (!fns)

    return;

  read_count_file (fns);

  while (fns)

    {

      function_t *fn = fns;

      fns = fn->next;

      fn->next = NULL;

      if (fn->counts)

        {

          unsigned src = fn->src;

          unsigned line = fn->line;

          unsigned block_no;

          function_t *probe, **prev;

          /* Now insert it into the source file's list of

             functions. Normally functions will be encountered in

             ascending order, so a simple scan is quick.  Note we're

             building this list in reverse order.  */

          for (prev = &sources[src].functions;

               (probe = *prev); prev = &probe->line_next)

            if (probe->line <= line)

              break;

          fn->line_next = probe;

          *prev = fn;

          /* Mark last line in files touched by function.  */

          for (block_no = 0; block_no != fn->num_blocks; block_no++)

            {

              unsigned *enc = fn->blocks[block_no].u.line.encoding;

              unsigned num = fn->blocks[block_no].u.line.num;

              for (; num--; enc++)

                if (!*enc)

                  {

                    if (enc[1] != src)

                      {

                        if (line >= sources[src].num_lines)

                          sources[src].num_lines = line + 1;

                        line = 0;

                        src = enc[1];

                      }

                    enc++;

                    num--;

                  }

                else if (*enc > line)

                  line = *enc;

            }

          if (line >= sources[src].num_lines)

            sources[src].num_lines = line + 1;

          solve_flow_graph (fn);

          if (fn->has_catch)

            find_exception_blocks (fn);

          *fn_end = fn;

          fn_end = &fn->next;

        }

      else

        /* The function was not in the executable -- some other

           instance must have been selected.  */

        release_function (fn);

    }

}

static void

generate_results (const char *file_name)

{

  unsigned ix;

  source_t *src;

  function_t *fn;

  for (ix = n_sources, src = sources; ix--; src++)

    if (src->num_lines)

      src->lines = XCNEWVEC (line_t, src->num_lines);

  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");

        }

    }

  if (file_name)

    {

      name_map_t *name_map = (name_map_t *)bsearch

        (file_name, names, n_names, sizeof (*names), name_search);

      if (name_map)

        file_name = sources[name_map->src].coverage.name;

      else

        file_name = canonicalize_name (file_name);

    }

  for (ix = n_sources, src = sources; ix--; src++)

    {

      if (flag_relative_only)

        {

          /* Ignore this source, if it is an absolute path (after

             source prefix removal).  */

          char first = src->coverage.name[0];

#if HAVE_DOS_BASED_FILE_SYSTEM

          if (first && src->coverage.name[1] == ':')