gcc/alloc-pool.c

   1 /* Functions to support a pool of allocatable objects.
   2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006, 2007
   3    Free Software Foundation, Inc.
   4    Contributed by Daniel Berlin <dan@cgsoftware.com>
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "alloc-pool.h"
  25 #include "hashtab.h"
  26
  27 #define align_eight(x) (((x+7) >> 3) << 3)
  28
  29 /* The internal allocation object.  */
  30 typedef struct allocation_object_def
  31 {
  32 #ifdef ENABLE_CHECKING
  33   /* The ID of alloc pool which the object was allocated from.  */
  34   ALLOC_POOL_ID_TYPE id;
  35 #endif
  36
  37   union
  38     {
  39       /* The data of the object.  */
  40       char data[1];
  41
  42       /* Because we want any type of data to be well aligned after the ID,
  43          the following elements are here.  They are never accessed so
  44          the allocated object may be even smaller than this structure.  */
  45       char *align_p;
  46       HOST_WIDEST_INT align_i;
  47       long double align_ld;
  48     } u;
  49 } allocation_object;
  50
  51 /* Convert a pointer to allocation_object from a pointer to user data.  */
  52 #define ALLOCATION_OBJECT_PTR_FROM_USER_PTR(X)                          \
  53    ((allocation_object *) (((char *) (X))                               \
  54                            - offsetof (allocation_object, u.data)))
  55
  56 /* Convert a pointer to user data from a pointer to allocation_object.  */
  57 #define USER_PTR_FROM_ALLOCATION_OBJECT_PTR(X)                          \
  58    ((void *) (((allocation_object *) (X))->u.data))
  59
  60 #ifdef ENABLE_CHECKING
  61 /* Last used ID.  */
  62 static ALLOC_POOL_ID_TYPE last_id;
  63 #endif
  64
  65 #ifdef GATHER_STATISTICS
  66
  67 /* Store information about each particular alloc_pool.  */
  68 struct alloc_pool_descriptor
  69 {
  70   const char *name;
  71   int allocated;
  72   int created;
  73   int peak;
  74   int current;
  75 };
  76
  77 /* Hashtable mapping alloc_pool names to descriptors.  */
  78 static htab_t alloc_pool_hash;
  79
  80 /* Hashtable helpers.  */
  81 static hashval_t
  82 hash_descriptor (const void *p)
  83 {
  84   const struct alloc_pool_descriptor *d = p;
  85   return htab_hash_pointer (d->name);
  86 }
  87 static int
  88 eq_descriptor (const void *p1, const void *p2)
  89 {
  90   const struct alloc_pool_descriptor *d = p1;
  91   return d->name == p2;
  92 }
  93
  94 /* For given name, return descriptor, create new if needed.  */
  95 static struct alloc_pool_descriptor *
  96 alloc_pool_descriptor (const char *name)
  97 {
  98   struct alloc_pool_descriptor **slot;
  99
 100   if (!alloc_pool_hash)
 101     alloc_pool_hash = htab_create (10, hash_descriptor, eq_descriptor, NULL);
 102
 103   slot = (struct alloc_pool_descriptor **)
 104     htab_find_slot_with_hash (alloc_pool_hash, name,
 105                               htab_hash_pointer (name),
 106                               1);
 107   if (*slot)
 108     return *slot;
 109   *slot = xcalloc (sizeof (**slot), 1);
 110   (*slot)->name = name;
 111   return *slot;
 112 }
 113 #endif
 114
 115 /* Create a pool of things of size SIZE, with NUM in each block we
 116    allocate.  */
 117
 118 alloc_pool
 119 create_alloc_pool (const char *name, size_t size, size_t num)
 120 {
 121   alloc_pool pool;
 122   size_t pool_size, header_size;
 123 #ifdef GATHER_STATISTICS
 124   struct alloc_pool_descriptor *desc;
 125 #endif
 126
 127   gcc_assert (name);
 128
 129   /* Make size large enough to store the list header.  */
 130   if (size < sizeof (alloc_pool_list))
 131     size = sizeof (alloc_pool_list);
 132
 133   /* Now align the size to a multiple of 4.  */
 134   size = align_eight (size);
 135
 136 #ifdef ENABLE_CHECKING
 137   /* Add the aligned size of ID.  */
 138   size += offsetof (allocation_object, u.data);
 139 #endif
 140
 141   /* Um, we can't really allocate 0 elements per block.  */
 142   gcc_assert (num);
 143
 144   /* Find the size of the pool structure, and the name.  */
 145   pool_size = sizeof (struct alloc_pool_def);
 146
 147   /* and allocate that much memory.  */
 148   pool = xmalloc (pool_size);
 149
 150   /* Now init the various pieces of our pool structure.  */
 151   pool->name = /*xstrdup (name)*/name;
 152 #ifdef GATHER_STATISTICS
 153   desc = alloc_pool_descriptor (name);
 154   desc->created++;
 155 #endif
 156   pool->elt_size = size;
 157   pool->elts_per_block = num;
 158
 159   /* List header size should be a multiple of 8.  */
 160   header_size = align_eight (sizeof (struct alloc_pool_list_def));
 161
 162   pool->block_size = (size * num) + header_size;
 163   pool->returned_free_list = NULL;
 164   pool->virgin_free_list = NULL;
 165   pool->virgin_elts_remaining = 0;
 166   pool->elts_allocated = 0;
 167   pool->elts_free = 0;
 168   pool->blocks_allocated = 0;
 169   pool->block_list = NULL;
 170
 171 #ifdef ENABLE_CHECKING
 172   /* Increase the last used ID and use it for this pool.
 173      ID == 0 is used for free elements of pool so skip it.  */
 174   last_id++;
 175   if (last_id == 0)
 176     last_id++;
 177
 178   pool->id = last_id;
 179 #endif
 180
 181   return (pool);
 182 }
 183
 184 /* Free all memory allocated for the given memory pool.  */
 185 void
 186 empty_alloc_pool (alloc_pool pool)
 187 {
 188   alloc_pool_list block, next_block;
 189 #ifdef GATHER_STATISTICS
 190   struct alloc_pool_descriptor *desc = alloc_pool_descriptor (pool->name);
 191 #endif
 192
 193   gcc_assert (pool);
 194
 195   /* Free each block allocated to the pool.  */
 196   for (block = pool->block_list; block != NULL; block = next_block)
 197     {
 198       next_block = block->next;
 199       free (block);
 200 #ifdef GATHER_STATISTICS
 201       desc->current -= pool->block_size;
 202 #endif
 203     }
 204
 205   pool->returned_free_list = NULL;
 206   pool->virgin_free_list = NULL;
 207   pool->virgin_elts_remaining = 0;
 208   pool->elts_allocated = 0;
 209   pool->elts_free = 0;
 210   pool->blocks_allocated = 0;
 211   pool->block_list = NULL;
 212 }
 213
 214 /* Free all memory allocated for the given memory pool and the pool itself.  */
 215 void
 216 free_alloc_pool (alloc_pool pool)
 217 {
 218   /* First empty the pool.  */
 219   empty_alloc_pool (pool);
 220 #ifdef ENABLE_CHECKING
 221   memset (pool, 0xaf, sizeof (*pool));
 222 #endif
 223   /* Lastly, free the pool.  */
 224   free (pool);
 225 }
 226
 227 /* Frees the alloc_pool, if it is empty and zero *POOL in this case.  */
 228 void
 229 free_alloc_pool_if_empty (alloc_pool *pool)
 230 {
 231   if ((*pool)->elts_free == (*pool)->elts_allocated)
 232     {
 233       free_alloc_pool (*pool);
 234       *pool = NULL;
 235     }
 236 }
 237
 238 /* Allocates one element from the pool specified.  */
 239 void *
 240 pool_alloc (alloc_pool pool)
 241 {
 242   alloc_pool_list header;
 243 #ifdef GATHER_STATISTICS
 244   struct alloc_pool_descriptor *desc = alloc_pool_descriptor (pool->name);
 245
 246   desc->allocated+=pool->elt_size;
 247 #endif
 248
 249   gcc_assert (pool);
 250
 251   /* If there are no more free elements, make some more!.  */
 252   if (!pool->returned_free_list)
 253     {
 254       char *block;
 255       if (!pool->virgin_elts_remaining)
 256         {
 257           alloc_pool_list block_header;
 258
 259           /* Make the block.  */
 260           block = XNEWVEC (char, pool->block_size);
 261           block_header = (alloc_pool_list) block;
 262           block += align_eight (sizeof (struct alloc_pool_list_def));
 263 #ifdef GATHER_STATISTICS
 264           desc->current += pool->block_size;
 265           if (desc->peak < desc->current)
 266             desc->peak = desc->current;
 267 #endif
 268
 269           /* Throw it on the block list.  */
 270           block_header->next = pool->block_list;
 271           pool->block_list = block_header;
 272
 273           /* Make the block available for allocation.  */
 274           pool->virgin_free_list = block;
 275           pool->virgin_elts_remaining = pool->elts_per_block;
 276
 277           /* Also update the number of elements we have free/allocated, and
 278              increment the allocated block count.  */
 279           pool->elts_allocated += pool->elts_per_block;
 280           pool->elts_free += pool->elts_per_block;
 281           pool->blocks_allocated += 1;
 282         }
 283
 284
 285       /* We now know that we can take the first elt off the virgin list and
 286          put it on the returned list. */
 287       block = pool->virgin_free_list;
 288       header = (alloc_pool_list) USER_PTR_FROM_ALLOCATION_OBJECT_PTR (block);
 289       header->next = NULL;
 290 #ifdef ENABLE_CHECKING
 291       /* Mark the element to be free.  */
 292       ((allocation_object *) block)->id = 0;
 293 #endif
 294       pool->returned_free_list = header;
 295       pool->virgin_free_list += pool->elt_size;
 296       pool->virgin_elts_remaining--;
 297
 298     }
 299
 300   /* Pull the first free element from the free list, and return it.  */
 301   header = pool->returned_free_list;
 302   pool->returned_free_list = header->next;
 303   pool->elts_free--;
 304
 305 #ifdef ENABLE_CHECKING
 306   /* Set the ID for element.  */
 307   ALLOCATION_OBJECT_PTR_FROM_USER_PTR (header)->id = pool->id;
 308 #endif
 309
 310   return ((void *) header);
 311 }
 312
 313 /* Puts PTR back on POOL's free list.  */
 314 void
 315 pool_free (alloc_pool pool, void *ptr)
 316 {
 317   alloc_pool_list header;
 318
 319   gcc_assert (ptr);
 320
 321 #ifdef ENABLE_CHECKING
 322   /* Check whether the PTR was allocated from POOL.  */
 323   gcc_assert (pool->id == ALLOCATION_OBJECT_PTR_FROM_USER_PTR (ptr)->id);
 324
 325   memset (ptr, 0xaf, pool->elt_size - offsetof (allocation_object, u.data));
 326
 327   /* Mark the element to be free.  */
 328   ALLOCATION_OBJECT_PTR_FROM_USER_PTR (ptr)->id = 0;
 329 #else
 330   /* Check if we free more than we allocated, which is Bad (TM).  */
 331   gcc_assert (pool->elts_free < pool->elts_allocated);
 332 #endif
 333
 334   header = (alloc_pool_list) ptr;
 335   header->next = pool->returned_free_list;
 336   pool->returned_free_list = header;
 337   pool->elts_free++;
 338 }
 339 /* Output per-alloc_pool statistics.  */
 340 #ifdef GATHER_STATISTICS
 341
 342 /* Used to accumulate statistics about alloc_pool sizes.  */
 343 struct output_info
 344 {
 345   int count;
 346   int size;
 347 };
 348
 349 /* Called via htab_traverse.  Output alloc_pool descriptor pointed out by SLOT
 350    and update statistics.  */
 351 static int
 352 print_statistics (void **slot, void *b)
 353 {
 354   struct alloc_pool_descriptor *d = (struct alloc_pool_descriptor *) *slot;
 355   struct output_info *i = (struct output_info *) b;
 356
 357   if (d->allocated)
 358     {
 359       fprintf (stderr, "%-21s %6d %10d %10d %10d\n", d->name,
 360                d->created, d->allocated, d->peak, d->current);
 361       i->size += d->allocated;
 362       i->count += d->created;
 363     }
 364   return 1;
 365 }
 366 #endif
 367
 368 /* Output per-alloc_pool memory usage statistics.  */
 369 void
 370 dump_alloc_pool_statistics (void)
 371 {
 372 #ifdef GATHER_STATISTICS
 373   struct output_info info;
 374
 375   if (!alloc_pool_hash)
 376     return;
 377
 378   fprintf (stderr, "\nAlloc-pool Kind        Pools  Allocated      Peak        Leak\n");
 379   fprintf (stderr, "-------------------------------------------------------------\n");
 380   info.count = 0;
 381   info.size = 0;
 382   htab_traverse (alloc_pool_hash, print_statistics, &info);
 383   fprintf (stderr, "-------------------------------------------------------------\n");
 384   fprintf (stderr, "%-20s %7d %10d\n",
 385            "Total", info.count, info.size);
 386   fprintf (stderr, "-------------------------------------------------------------\n");
 387 #endif
 388 }