Subversion Repositories scarts

/* Read and write coverage files, and associated functionality.

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

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

   Contributed by James E. Wilson, UC Berkeley/Cygnus Support;

   based on some ideas from Dain Samples of UC Berkeley.

   Further mangling by Bob Manson, Cygnus Support.

   Further mangled by Nathan Sidwell, CodeSourcery

This file is part of GCC.

GCC 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.

GCC 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 GCC; see the file COPYING.  If not, write to the Free

Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301, USA.  */

#define GCOV_LINKAGE

#include "config.h"

#include "system.h"

#include "coretypes.h"

#include "tm.h"

#include "rtl.h"

#include "tree.h"

#include "flags.h"

#include "output.h"

#include "regs.h"

#include "expr.h"

#include "function.h"

#include "toplev.h"

#include "ggc.h"

#include "coverage.h"

#include "langhooks.h"

#include "hashtab.h"

#include "tree-iterator.h"

#include "cgraph.h"

#include "gcov-io.c"

struct function_list

{

  struct function_list *next;    /* next function */

  unsigned ident;                /* function ident */

  unsigned checksum;             /* function checksum */

  unsigned n_ctrs[GCOV_COUNTERS];/* number of counters.  */

};

/* Counts information for a function.  */

typedef struct counts_entry

{

  /* We hash by  */

  unsigned ident;

  unsigned ctr;

  /* Store  */

  unsigned checksum;

  gcov_type *counts;

  struct gcov_ctr_summary summary;

  /* Workspace */

  struct counts_entry *chain;

} counts_entry_t;

static struct function_list *functions_head = 0;

static struct function_list **functions_tail = &functions_head;

static unsigned no_coverage = 0;

/* Cumulative counter information for whole program.  */

static unsigned prg_ctr_mask; /* Mask of counter types generated.  */

static unsigned prg_n_ctrs[GCOV_COUNTERS]; /* Total counters allocated.  */

/* Counter information for current function.  */

static unsigned fn_ctr_mask; /* Mask of counters used.  */

static unsigned fn_n_ctrs[GCOV_COUNTERS]; /* Counters allocated.  */

static unsigned fn_b_ctrs[GCOV_COUNTERS]; /* Allocation base.  */

/* Name of the output file for coverage output file.  */

static char *bbg_file_name;

static unsigned bbg_file_opened;

static int bbg_function_announced;

/* Name of the count data file.  */

static char *da_file_name;

/* Hash table of count data.  */

static htab_t counts_hash = NULL;

/* Trees representing the counter table arrays.  */

static GTY(()) tree tree_ctr_tables[GCOV_COUNTERS];

/* The names of the counter tables.  Not used if we're

   generating counters at tree level.  */

static GTY(()) rtx ctr_labels[GCOV_COUNTERS];

/* The names of merge functions for counters.  */

static const char *const ctr_merge_functions[GCOV_COUNTERS] = GCOV_MERGE_FUNCTIONS;

static const char *const ctr_names[GCOV_COUNTERS] = GCOV_COUNTER_NAMES;

/* Forward declarations.  */

static hashval_t htab_counts_entry_hash (const void *);

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

static void htab_counts_entry_del (void *);

static void read_counts_file (void);

static unsigned compute_checksum (void);

static unsigned coverage_checksum_string (unsigned, const char *);

static tree build_fn_info_type (unsigned);

static tree build_fn_info_value (const struct function_list *, tree);

static tree build_ctr_info_type (void);

static tree build_ctr_info_value (unsigned, tree);

static tree build_gcov_info (void);

static void create_coverage (void);

/* Return the type node for gcov_type.  */

tree

get_gcov_type (void)

{

  return lang_hooks.types.type_for_size (GCOV_TYPE_SIZE, false);

}

/* Return the type node for gcov_unsigned_t.  */

static tree

get_gcov_unsigned_t (void)

{

  return lang_hooks.types.type_for_size (32, true);

}

static hashval_t

htab_counts_entry_hash (const void *of)

{

  const counts_entry_t *entry = of;

  return entry->ident * GCOV_COUNTERS + entry->ctr;

}

static int

htab_counts_entry_eq (const void *of1, const void *of2)

{

  const counts_entry_t *entry1 = of1;

  const counts_entry_t *entry2 = of2;

  return entry1->ident == entry2->ident && entry1->ctr == entry2->ctr;

}

static void

htab_counts_entry_del (void *of)

{

  counts_entry_t *entry = of;

  free (entry->counts);

  free (entry);

}

/* Read in the counts file, if available.  */

static void

read_counts_file (void)

{

  gcov_unsigned_t fn_ident = 0;

  gcov_unsigned_t checksum = -1;

  counts_entry_t *summaried = NULL;

  unsigned seen_summary = 0;

  gcov_unsigned_t tag;

  int is_error = 0;

  if (!gcov_open (da_file_name, 1))

    return;

  if (!gcov_magic (gcov_read_unsigned (), GCOV_DATA_MAGIC))

    {

      warning (0, "%qs is not a gcov data file", da_file_name);

      gcov_close ();

      return;

    }

  else if ((tag = gcov_read_unsigned ()) != GCOV_VERSION)

    {

      char v[4], e[4];

      GCOV_UNSIGNED2STRING (v, tag);

      GCOV_UNSIGNED2STRING (e, GCOV_VERSION);

      warning (0, "%qs is version %q.*s, expected version %q.*s",

               da_file_name, 4, v, 4, e);

      gcov_close ();

      return;

    }

  /* Read and discard the stamp.  */

  gcov_read_unsigned ();

  counts_hash = htab_create (10,

                             htab_counts_entry_hash, htab_counts_entry_eq,

                             htab_counts_entry_del);

  while ((tag = gcov_read_unsigned ()))

    {

      gcov_unsigned_t length;

      gcov_position_t offset;

      length = gcov_read_unsigned ();

      offset = gcov_position ();

      if (tag == GCOV_TAG_FUNCTION)

        {

          fn_ident = gcov_read_unsigned ();

          checksum = gcov_read_unsigned ();

          if (seen_summary)

            {

              /* We have already seen a summary, this means that this

                 new function begins a new set of program runs. We

                 must unlink the summaried chain.  */

              counts_entry_t *entry, *chain;

              for (entry = summaried; entry; entry = chain)

                {

                  chain = entry->chain;

                  entry->chain = NULL;

                }

              summaried = NULL;

              seen_summary = 0;

            }

        }

      else if (tag == GCOV_TAG_PROGRAM_SUMMARY)

        {

          counts_entry_t *entry;

          struct gcov_summary summary;

          gcov_read_summary (&summary);

          seen_summary = 1;

          for (entry = summaried; entry; entry = entry->chain)

            {

              struct gcov_ctr_summary *csum = &summary.ctrs[entry->ctr];

              entry->summary.runs += csum->runs;

              entry->summary.sum_all += csum->sum_all;

              if (entry->summary.run_max < csum->run_max)

                entry->summary.run_max = csum->run_max;

              entry->summary.sum_max += csum->sum_max;

            }

        }

      else if (GCOV_TAG_IS_COUNTER (tag) && fn_ident)

        {

          counts_entry_t **slot, *entry, elt;

          unsigned n_counts = GCOV_TAG_COUNTER_NUM (length);

          unsigned ix;

          elt.ident = fn_ident;

          elt.ctr = GCOV_COUNTER_FOR_TAG (tag);

          slot = (counts_entry_t **) htab_find_slot

            (counts_hash, &elt, INSERT);

          entry = *slot;

          if (!entry)

            {

              *slot = entry = xcalloc (1, sizeof (counts_entry_t));

              entry->ident = elt.ident;

              entry->ctr = elt.ctr;

              entry->checksum = checksum;

              entry->summary.num = n_counts;

              entry->counts = xcalloc (n_counts, sizeof (gcov_type));

            }

          else if (entry->checksum != checksum)

            {

              error ("coverage mismatch for function %u while reading execution counters",

                     fn_ident);

              error ("checksum is %x instead of %x", entry->checksum, checksum);

              htab_delete (counts_hash);

              break;

            }

          else if (entry->summary.num != n_counts)

            {

              error ("coverage mismatch for function %u while reading execution counters",

                     fn_ident);

              error ("number of counters is %d instead of %d", entry->summary.num, n_counts);

              htab_delete (counts_hash);

              break;

            }

          else if (elt.ctr >= GCOV_COUNTERS_SUMMABLE)

            {

              error ("cannot merge separate %s counters for function %u",

                     ctr_names[elt.ctr], fn_ident);

              goto skip_merge;

            }

          if (elt.ctr < GCOV_COUNTERS_SUMMABLE

              /* This should always be true for a just allocated entry,

                 and always false for an existing one. Check this way, in

                 case the gcov file is corrupt.  */

              && (!entry->chain || summaried != entry))

            {

              entry->chain = summaried;

              summaried = entry;

            }

          for (ix = 0; ix != n_counts; ix++)

            entry->counts[ix] += gcov_read_counter ();

        skip_merge:;

        }

      gcov_sync (offset, length);

      if ((is_error = gcov_is_error ()))

        {

          error (is_error < 0 ? "%qs has overflowed" : "%qs is corrupted",

                 da_file_name);

          htab_delete (counts_hash);

          break;

        }

    }

  gcov_close ();

}

/* Returns the counters for a particular tag.  */

gcov_type *

get_coverage_counts (unsigned counter, unsigned expected,

                     const struct gcov_ctr_summary **summary)

{

  counts_entry_t *entry, elt;

  gcov_unsigned_t checksum = -1;

  /* No hash table, no counts.  */

  if (!counts_hash)

    {

      static int warned = 0;

      if (!warned++)

        inform ((flag_guess_branch_prob

                 ? "file %s not found, execution counts estimated"

                 : "file %s not found, execution counts assumed to be zero"),

                da_file_name);

      return NULL;

    }

  elt.ident = current_function_funcdef_no + 1;

  elt.ctr = counter;

  entry = htab_find (counts_hash, &elt);

  if (!entry)

    {

      warning (0, "no coverage for function %qs found", IDENTIFIER_POINTER

               (DECL_ASSEMBLER_NAME (current_function_decl)));

      return 0;

    }

  checksum = compute_checksum ();

  if (entry->checksum != checksum)

    {

      error ("coverage mismatch for function %qs while reading counter %qs",

             IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (current_function_decl)),

             ctr_names[counter]);

      error ("checksum is %x instead of %x", entry->checksum, checksum);

      return 0;

    }

  else if (entry->summary.num != expected)

    {

      error ("coverage mismatch for function %qs while reading counter %qs",

             IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (current_function_decl)),

             ctr_names[counter]);

      error ("number of counters is %d instead of %d", entry->summary.num, expected);

      return 0;

    }

  if (summary)

    *summary = &entry->summary;

  return entry->counts;

}

/* Allocate NUM counters of type COUNTER. Returns nonzero if the

   allocation succeeded.  */

int

coverage_counter_alloc (unsigned counter, unsigned num)

{

  if (no_coverage)

    return 0;

  if (!num)

    return 1;

  if (!tree_ctr_tables[counter])

    {

      /* Generate and save a copy of this so it can be shared.  */

      /* We don't know the size yet; make it big enough that nobody

         will make any clever transformation on it.  */

      char buf[20];

      tree gcov_type_node = get_gcov_type ();

      tree domain_tree

        = build_index_type (build_int_cst (NULL_TREE, 1000)); /* replaced later */

      tree gcov_type_array_type

        = build_array_type (gcov_type_node, domain_tree);

      tree_ctr_tables[counter]

        = build_decl (VAR_DECL, NULL_TREE, gcov_type_array_type);

      TREE_STATIC (tree_ctr_tables[counter]) = 1;

      ASM_GENERATE_INTERNAL_LABEL (buf, "LPBX", counter + 1);

      DECL_NAME (tree_ctr_tables[counter]) = get_identifier (buf);

      DECL_ALIGN (tree_ctr_tables[counter]) = TYPE_ALIGN (gcov_type_node);

    }

  fn_b_ctrs[counter] = fn_n_ctrs[counter];

  fn_n_ctrs[counter] += num;

  fn_ctr_mask |= 1 << counter;

  return 1;

}

/* Generate a tree to access COUNTER NO.  */

tree

tree_coverage_counter_ref (unsigned counter, unsigned no)

{

  tree gcov_type_node = get_gcov_type ();

  tree domain_type = TYPE_DOMAIN (TREE_TYPE (tree_ctr_tables[counter]));

  gcc_assert (no < fn_n_ctrs[counter] - fn_b_ctrs[counter]);

  no += prg_n_ctrs[counter] + fn_b_ctrs[counter];

  /* "no" here is an array index, scaled to bytes later.  */

  return build4 (ARRAY_REF, gcov_type_node, tree_ctr_tables[counter],

                 fold_convert (domain_type,

                               build_int_cst (NULL_TREE, no)),

                 TYPE_MIN_VALUE (domain_type),

                 size_binop (EXACT_DIV_EXPR, TYPE_SIZE_UNIT (gcov_type_node),

                             size_int (TYPE_ALIGN_UNIT (gcov_type_node))));

}

/* Generate a checksum for a string.  CHKSUM is the current

   checksum.  */

static unsigned

coverage_checksum_string (unsigned chksum, const char *string)

{

  int i;

  char *dup = NULL;

  /* Look for everything that looks if it were produced by

     get_file_function_name_long and zero out the second part

     that may result from flag_random_seed.  This is not critical

     as the checksums are used only for sanity checking.  */

  for (i = 0; string[i]; i++)

    {

      int offset = 0;

      if (!strncmp (string + i, "_GLOBAL__N_", 11))

      offset = 11;

      if (!strncmp (string + i, "_GLOBAL__", 9))

      offset = 9;

      /* C++ namespaces do have scheme:

         _GLOBAL__N_<filename>_<wrongmagicnumber>_<magicnumber>functionname

       since filename might contain extra underscores there seems

       to be no better chance then walk all possible offsets looking

       for magicnuber.  */

      if (offset)

        for (;string[offset]; offset++)

        for (i = i + offset; string[i]; i++)

          if (string[i]=='_')

            {

              int y;

              for (y = 1; y < 9; y++)

                if (!(string[i + y] >= '0' && string[i + y] <= '9')

                    && !(string[i + y] >= 'A' && string[i + y] <= 'F'))

                  break;

              if (y != 9 || string[i + 9] != '_')

                continue;

              for (y = 10; y < 18; y++)

                if (!(string[i + y] >= '0' && string[i + y] <= '9')

                    && !(string[i + y] >= 'A' && string[i + y] <= 'F'))

                  break;

              if (y != 18)

                continue;

              if (!dup)

                string = dup = xstrdup (string);

              for (y = 10; y < 18; y++)

                dup[i + y] = '0';

            }

        break;

    }

  chksum = crc32_string (chksum, string);

  if (dup)

    free (dup);

  return chksum;

}

/* Compute checksum for the current function.  We generate a CRC32.  */

static unsigned

compute_checksum (void)

{

  expanded_location xloc

    = expand_location (DECL_SOURCE_LOCATION (current_function_decl));

  unsigned chksum = xloc.line;

  chksum = coverage_checksum_string (chksum, xloc.file);

  chksum = coverage_checksum_string

    (chksum, IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (current_function_decl)));

  return chksum;

}

/* Begin output to the graph file for the current function.

   Opens the output file, if not already done. Writes the

   function header, if not already done. Returns nonzero if data

   should be output.  */

int

coverage_begin_output (void)

{

  if (no_coverage)

    return 0;

  if (!bbg_function_announced)

    {

      expanded_location xloc

        = expand_location (DECL_SOURCE_LOCATION (current_function_decl));

      unsigned long offset;

      if (!bbg_file_opened)

        {

          if (!gcov_open (bbg_file_name, -1))

            error ("cannot open %s", bbg_file_name);

          else

            {

              gcov_write_unsigned (GCOV_NOTE_MAGIC);

              gcov_write_unsigned (GCOV_VERSION);

              gcov_write_unsigned (local_tick);

            }

          bbg_file_opened = 1;

        }

      /* Announce function */

      offset = gcov_write_tag (GCOV_TAG_FUNCTION);

      gcov_write_unsigned (current_function_funcdef_no + 1);

      gcov_write_unsigned (compute_checksum ());

      gcov_write_string (IDENTIFIER_POINTER

                         (DECL_ASSEMBLER_NAME (current_function_decl)));

      gcov_write_string (xloc.file);

      gcov_write_unsigned (xloc.line);

      gcov_write_length (offset);

      bbg_function_announced = 1;

    }

  return !gcov_is_error ();

}

/* Finish coverage data for the current function. Verify no output

   error has occurred.  Save function coverage counts.  */

void

coverage_end_function (void)

{

  unsigned i;

  if (bbg_file_opened > 1 && gcov_is_error ())

    {

      warning (0, "error writing %qs", bbg_file_name);

      bbg_file_opened = -1;

    }

  if (fn_ctr_mask)

    {

      struct function_list *item;

      item = xmalloc (sizeof (struct function_list));

      *functions_tail = item;

      functions_tail = &item->next;

      item->next = 0;

      item->ident = current_function_funcdef_no + 1;

      item->checksum = compute_checksum ();

      for (i = 0; i != GCOV_COUNTERS; i++)

        {

          item->n_ctrs[i] = fn_n_ctrs[i];

          prg_n_ctrs[i] += fn_n_ctrs[i];

          fn_n_ctrs[i] = fn_b_ctrs[i] = 0;

        }

      prg_ctr_mask |= fn_ctr_mask;

      fn_ctr_mask = 0;

    }

  bbg_function_announced = 0;

}

/* Creates the gcov_fn_info RECORD_TYPE.  */

static tree

build_fn_info_type (unsigned int counters)

{

  tree type = lang_hooks.types.make_type (RECORD_TYPE);

  tree field, fields;

  tree array_type;

  /* ident */

  fields = build_decl (FIELD_DECL, NULL_TREE, get_gcov_unsigned_t ());

  /* checksum */

  field = build_decl (FIELD_DECL, NULL_TREE, get_gcov_unsigned_t ());

  TREE_CHAIN (field) = fields;

  fields = field;

  array_type = build_int_cst (NULL_TREE, counters - 1);

  array_type = build_index_type (array_type);

  array_type = build_array_type (unsigned_type_node, array_type);

  /* counters */

  field = build_decl (FIELD_DECL, NULL_TREE, array_type);

  TREE_CHAIN (field) = fields;

  fields = field;

  finish_builtin_struct (type, "__gcov_fn_info", fields, NULL_TREE);

  return type;

}

/* Creates a CONSTRUCTOR for a gcov_fn_info. FUNCTION is

   the function being processed and TYPE is the gcov_fn_info

   RECORD_TYPE.  */

static tree

build_fn_info_value (const struct function_list *function, tree type)

{

  tree value = NULL_TREE;

  tree fields = TYPE_FIELDS (type);

  unsigned ix;

  tree array_value = NULL_TREE;

  /* ident */

  value = tree_cons (fields, build_int_cstu (get_gcov_unsigned_t (),

                                             function->ident), value);

  fields = TREE_CHAIN (fields);

  /* checksum */

  value = tree_cons (fields, build_int_cstu (get_gcov_unsigned_t (),

                                             function->checksum), value);

  fields = TREE_CHAIN (fields);

  /* counters */

  for (ix = 0; ix != GCOV_COUNTERS; ix++)

    if (prg_ctr_mask & (1 << ix))

      {

        tree counters = build_int_cstu (unsigned_type_node,

                                        function->n_ctrs[ix]);

        array_value = tree_cons (NULL_TREE, counters, array_value);

      }

  /* FIXME: use build_constructor directly.  */

  array_value = build_constructor_from_list (TREE_TYPE (fields),

                                             nreverse (array_value));

  value = tree_cons (fields, array_value, value);

  /* FIXME: use build_constructor directly.  */

  value = build_constructor_from_list (type, nreverse (value));

  return value;

}

/* Creates the gcov_ctr_info RECORD_TYPE.  */

static tree

build_ctr_info_type (void)

{

  tree type = lang_hooks.types.make_type (RECORD_TYPE);

  tree field, fields = NULL_TREE;