gcc/varray.c

   1 /* Virtual array support.
   2    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3    Free Software Foundation, Inc.
   4    Contributed by Cygnus Solutions.
   5
   6    This file is part of GCC.
   7
   8    GCC is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    GCC is distributed in the hope that it will be useful, but WITHOUT
  14    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  16    License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with GCC; see the file COPYING.  If not, write to the Free
  20    the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  21    MA 02111-1307, USA.  */
  22
  23 #include "config.h"
  24 #include "errors.h"
  25 #include "system.h"
  26 #include "coretypes.h"
  27 #include "tm.h"
  28 #include "varray.h"
  29 #include "ggc.h"
  30 #include "hashtab.h"
  31
  32 #define VARRAY_HDR_SIZE (sizeof (struct varray_head_tag) - sizeof (varray_data))
  33
  34 #ifdef GATHER_STATISTICS
  35
  36 /* Store information about each particular varray.  */
  37 struct varray_descriptor
  38 {
  39   const char *name;
  40   int allocated;
  41   int created;
  42   int resized;
  43   int copied;
  44 };
  45
  46 /* Hashtable mapping varray names to descriptors.  */
  47 static htab_t varray_hash;
  48
  49 /* Hashtable helpers.  */
  50 static hashval_t
  51 hash_descriptor (const void *p)
  52 {
  53   const struct varray_descriptor *d = p;
  54   return htab_hash_pointer (d->name);
  55 }
  56 static int
  57 eq_descriptor (const void *p1, const void *p2)
  58 {
  59   const struct varray_descriptor *d = p1;
  60   return d->name == p2;
  61 }
  62
  63 /* For given name, return descriptor, create new if needed.  */
  64 static struct varray_descriptor *
  65 varray_descriptor (const char *name)
  66 {
  67   struct varray_descriptor **slot;
  68
  69   if (!varray_hash)
  70     varray_hash = htab_create (10, hash_descriptor, eq_descriptor, NULL);
  71
  72   slot = (struct varray_descriptor **)
  73     htab_find_slot_with_hash (varray_hash, name,
  74                               htab_hash_pointer (name),
  75                               1);
  76   if (*slot)
  77     return *slot;
  78   *slot = xcalloc (sizeof (**slot), 1);
  79   (*slot)->name = name;
  80   return *slot;
  81 }
  82 #endif
  83
  84 /* Do not add any more non-GC items here.  Please either remove or GC
  85    those items that are not GCed.  */
  86
  87 static const struct {
  88   unsigned char size;
  89   bool uses_ggc;
  90 } element[NUM_VARRAY_DATA] = {
  91   { sizeof (char), 1 },
  92   { sizeof (unsigned char), 1 },
  93   { sizeof (short), 1 },
  94   { sizeof (unsigned short), 1 },
  95   { sizeof (int), 1 },
  96   { sizeof (unsigned int), 1 },
  97   { sizeof (long), 1 },
  98   { sizeof (unsigned long), 1 },
  99   { sizeof (HOST_WIDE_INT), 1 },
 100   { sizeof (unsigned HOST_WIDE_INT), 1 },
 101   { sizeof (void *), 1 },
 102   { sizeof (char *), 1 },
 103   { sizeof (struct rtx_def *), 1 },
 104   { sizeof (struct rtvec_def *), 1 },
 105   { sizeof (union tree_node *), 1 },
 106   { sizeof (struct bitmap_head_def *), 1 },
 107   { sizeof (struct reg_info_def *), 0 },
 108   { sizeof (struct const_equiv_data), 0 },
 109   { sizeof (struct basic_block_def *), 0 },
 110   { sizeof (struct elt_list *), 1 },
 111 };
 112
 113 /* Allocate a virtual array with NUM_ELEMENT elements, each of which is
 114    ELEMENT_SIZE bytes long, named NAME.  Array elements are zeroed.  */
 115 varray_type
 116 varray_init (size_t num_elements, enum varray_data_enum element_kind,
 117              const char *name)
 118 {
 119   size_t data_size = num_elements * element[element_kind].size;
 120   varray_type ptr;
 121 #ifdef GATHER_STATISTICS
 122   struct varray_descriptor *desc = varray_descriptor (name);
 123
 124   desc->created++;
 125   desc->allocated += data_size + VARRAY_HDR_SIZE;
 126 #endif
 127   if (element[element_kind].uses_ggc)
 128     ptr = ggc_alloc_cleared (VARRAY_HDR_SIZE + data_size);
 129   else
 130     ptr = xcalloc (VARRAY_HDR_SIZE + data_size, 1);
 131
 132   ptr->num_elements = num_elements;
 133   ptr->elements_used = 0;
 134   ptr->type = element_kind;
 135   ptr->name = name;
 136   return ptr;
 137 }
 138
 139 /* Grow/shrink the virtual array VA to N elements.  Zero any new elements
 140    allocated.  */
 141 varray_type
 142 varray_grow (varray_type va, size_t n)
 143 {
 144   size_t old_elements = va->num_elements;
 145   if (n != old_elements)
 146     {
 147       size_t elem_size = element[va->type].size;
 148       size_t old_data_size = old_elements * elem_size;
 149       size_t data_size = n * elem_size;
 150 #ifdef GATHER_STATISTICS
 151       struct varray_descriptor *desc = varray_descriptor (va->name);
 152       varray_type oldva = va;
 153
 154       if (data_size > old_data_size)
 155         desc->allocated += data_size - old_data_size;
 156       desc->resized ++;
 157 #endif
 158
 159
 160       if (element[va->type].uses_ggc)
 161         va = ggc_realloc (va, VARRAY_HDR_SIZE + data_size);
 162       else
 163         va = xrealloc (va, VARRAY_HDR_SIZE + data_size);
 164       va->num_elements = n;
 165       if (n > old_elements)
 166         memset (&va->data.c[old_data_size], 0, data_size - old_data_size);
 167 #ifdef GATHER_STATISTICS
 168       if (oldva != va)
 169         desc->copied++;
 170 #endif
 171     }
 172
 173   return va;
 174 }
 175
 176 /* Reset a varray to its original state.  */
 177 void
 178 varray_clear (varray_type va)
 179 {
 180   size_t data_size = element[va->type].size * va->num_elements;
 181
 182   memset (va->data.c, 0, data_size);
 183   va->elements_used = 0;
 184 }
 185
 186 /* Check the bounds of a varray access.  */
 187
 188 #if defined ENABLE_CHECKING && (GCC_VERSION >= 2007)
 189
 190 void
 191 varray_check_failed (varray_type va, size_t n, const char *file, int line,
 192                      const char *function)
 193 {
 194   internal_error ("virtual array %s[%lu]: element %lu out of bounds "
 195                   "in %s, at %s:%d",
 196                   va->name, (unsigned long) va->num_elements, (unsigned long) n,
 197                   function, trim_filename (file), line);
 198 }
 199
 200 void
 201 varray_underflow (varray_type va, const char *file, int line,
 202                   const char *function)
 203 {
 204   internal_error ("underflowed virtual array %s in %s, at %s:%d",
 205                   va->name, function, trim_filename (file), line);
 206 }
 207
 208 #endif
 209
 210 /* Output per-varray statistics.  */
 211 #ifdef GATHER_STATISTICS
 212
 213 /* Used to accumulate statistics about varray sizes.  */
 214 struct output_info
 215 {
 216   int count;
 217   int size;
 218 };
 219
 220 /* Called via htab_traverse.  Output varray descriptor pointed out by SLOT
 221    and update statistics.  */
 222 static int
 223 print_statistics (void **slot, void *b)
 224 {
 225   struct varray_descriptor *d = (struct varray_descriptor *) *slot;
 226   struct output_info *i = (struct output_info *) b;
 227
 228   if (d->allocated)
 229     {
 230       fprintf (stderr, "%-21s %6d %10d %7d %7d\n", d->name,
 231                d->created, d->allocated, d->resized, d->copied);
 232       i->size += d->allocated;
 233       i->count += d->created;
 234     }
 235   return 1;
 236 }
 237 #endif
 238
 239 /* Output per-varray memory usage statistics.  */
 240 void dump_varray_statistics (void)
 241 {
 242 #ifdef GATHER_STATISTICS
 243   struct output_info info;
 244
 245   fprintf (stderr, "\nVARRAY Kind            Count      Bytes  Resized copied\n");
 246   fprintf (stderr, "-------------------------------------------------------\n");
 247   info.count = 0;
 248   info.size = 0;
 249   htab_traverse (varray_hash, print_statistics, &info);
 250   fprintf (stderr, "-------------------------------------------------------\n");
 251   fprintf (stderr, "%-20s %7d %10d\n",
 252            "Total", info.count, info.size);
 253   fprintf (stderr, "-------------------------------------------------------\n");
 254 #endif
 255 }