gcc/stringpool.c

   1 /* String pool for GCC.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 /* String text, identifier text and identifier node allocator.  Strings
  22    allocated by ggc_alloc_string are stored in an obstack which is
  23    never shrunk.  Identifiers are uniquely stored in a hash table.
  24
  25    We use cpplib's hash table implementation.  libiberty's
  26    hashtab.c is not used because it requires 100% average space
  27    overhead per string, which is unacceptable.  Also, this algorithm
  28    is faster.  */
  29
  30 #include "config.h"
  31 #include "system.h"
  32 #include "coretypes.h"
  33 #include "tm.h"
  34 #include "ggc.h"
  35 #include "tree.h"
  36 #include "symtab.h"
  37 #include "cpplib.h"
  38
  39 /* The "" allocated string.  */
  40 const char empty_string[] = "";
  41
  42 /* Character strings, each containing a single decimal digit.
  43    Written this way to save space.  */
  44 const char digit_vector[] = {
  45   '0', 0, '1', 0, '2', 0, '3', 0, '4', 0,
  46   '5', 0, '6', 0, '7', 0, '8', 0, '9', 0
  47 };
  48
  49 struct ht *ident_hash;
  50
  51 static hashnode alloc_node (hash_table *);
  52 static int mark_ident (struct cpp_reader *, hashnode, const void *);
  53
  54 static void *
  55 stringpool_ggc_alloc (size_t x)
  56 {
  57   return ggc_alloc (x);
  58 }
  59
  60 /* Initialize the string pool.  */
  61 void
  62 init_stringpool (void)
  63 {
  64   /* Create with 16K (2^14) entries.  */
  65   ident_hash = ht_create (14);
  66   ident_hash->alloc_node = alloc_node;
  67   ident_hash->alloc_subobject = stringpool_ggc_alloc;
  68 }
  69
  70 /* Allocate a hash node.  */
  71 static hashnode
  72 alloc_node (hash_table *table ATTRIBUTE_UNUSED)
  73 {
  74   return GCC_IDENT_TO_HT_IDENT (make_node (IDENTIFIER_NODE));
  75 }
  76
  77 /* Allocate and return a string constant of length LENGTH, containing
  78    CONTENTS.  If LENGTH is -1, CONTENTS is assumed to be a
  79    nul-terminated string, and the length is calculated using strlen.
  80    If the same string constant has been allocated before, that copy is
  81    returned this time too.  */
  82
  83 const char *
  84 ggc_alloc_string (const char *contents, int length)
  85 {
  86   char *result;
  87
  88   if (length == -1)
  89     length = strlen (contents);
  90
  91   if (length == 0)
  92     return empty_string;
  93   if (length == 1 && ISDIGIT (contents[0]))
  94     return digit_string (contents[0] - '0');
  95
  96   result = GGC_NEWVAR (char, length + 1);
  97   memcpy (result, contents, length + 1);
  98   return (const char *) result;
  99 }
 100
 101 /* Return an IDENTIFIER_NODE whose name is TEXT (a null-terminated string).
 102    If an identifier with that name has previously been referred to,
 103    the same node is returned this time.  */
 104
 105 #undef get_identifier
 106
 107 tree
 108 get_identifier (const char *text)
 109 {
 110   hashnode ht_node = ht_lookup (ident_hash,
 111                                 (const unsigned char *) text,
 112                                 strlen (text), HT_ALLOC);
 113
 114   /* ht_node can't be NULL here.  */
 115   return HT_IDENT_TO_GCC_IDENT (ht_node);
 116 }
 117
 118 /* Identical to get_identifier, except that the length is assumed
 119    known.  */
 120
 121 tree
 122 get_identifier_with_length (const char *text, size_t length)
 123 {
 124   hashnode ht_node = ht_lookup (ident_hash,
 125                                 (const unsigned char *) text,
 126                                 length, HT_ALLOC);
 127
 128   /* ht_node can't be NULL here.  */
 129   return HT_IDENT_TO_GCC_IDENT (ht_node);
 130 }
 131
 132 /* If an identifier with the name TEXT (a null-terminated string) has
 133    previously been referred to, return that node; otherwise return
 134    NULL_TREE.  */
 135
 136 tree
 137 maybe_get_identifier (const char *text)
 138 {
 139   hashnode ht_node;
 140
 141   ht_node = ht_lookup (ident_hash, (const unsigned char *) text,
 142                        strlen (text), HT_NO_INSERT);
 143   if (ht_node)
 144     return HT_IDENT_TO_GCC_IDENT (ht_node);
 145
 146   return NULL_TREE;
 147 }
 148
 149 /* Report some basic statistics about the string pool.  */
 150
 151 void
 152 stringpool_statistics (void)
 153 {
 154   ht_dump_statistics (ident_hash);
 155 }
 156 \f
 157 /* Mark an identifier for GC.  */
 158
 159 static int
 160 mark_ident (struct cpp_reader *pfile ATTRIBUTE_UNUSED, hashnode h,
 161             const void *v ATTRIBUTE_UNUSED)
 162 {
 163   gt_ggc_m_9tree_node (HT_IDENT_TO_GCC_IDENT (h));
 164   return 1;
 165 }
 166
 167 /* Return true if an identifier should be removed from the table.  */
 168
 169 static int
 170 maybe_delete_ident (struct cpp_reader *pfile ATTRIBUTE_UNUSED, hashnode h,
 171                     const void *v ATTRIBUTE_UNUSED)
 172 {
 173   return !ggc_marked_p (HT_IDENT_TO_GCC_IDENT (h));
 174 }
 175
 176 /* Mark the trees hanging off the identifier node for GGC.  These are
 177    handled specially (not using gengtype) because identifiers are only
 178    roots during one part of compilation.  */
 179
 180 void
 181 ggc_mark_stringpool (void)
 182 {
 183   ht_forall (ident_hash, mark_ident, NULL);
 184 }
 185
 186 /* Purge the identifier hash of identifiers which are no longer
 187    referenced.  */
 188
 189 void
 190 ggc_purge_stringpool (void)
 191 {
 192   ht_purge (ident_hash, maybe_delete_ident, NULL);
 193 }
 194
 195 /* Pointer-walking routine for strings (not very interesting, since
 196    strings don't contain pointers).  */
 197
 198 void
 199 gt_pch_p_S (void *obj ATTRIBUTE_UNUSED, void *x ATTRIBUTE_UNUSED,
 200             gt_pointer_operator op ATTRIBUTE_UNUSED,
 201             void *cookie ATTRIBUTE_UNUSED)
 202 {
 203 }
 204
 205 /* PCH pointer-walking routine for strings.  */
 206
 207 void
 208 gt_pch_n_S (const void *x)
 209 {
 210   gt_pch_note_object (CONST_CAST (void *, x), CONST_CAST (void *, x),
 211                       &gt_pch_p_S, gt_types_enum_last);
 212 }
 213 \f
 214 /* Handle saving and restoring the string pool for PCH.  */
 215
 216 /* SPD is saved in the PCH file and holds the information needed
 217    to restore the string pool.  */
 218
 219 struct string_pool_data GTY(())
 220 {
 221   struct ht_identifier * *
 222     GTY((length ("%h.nslots"),
 223          nested_ptr (union tree_node, "%h ? GCC_IDENT_TO_HT_IDENT (%h) : NULL",
 224                      "%h ? HT_IDENT_TO_GCC_IDENT (%h) : NULL")))
 225     entries;
 226   unsigned int nslots;
 227   unsigned int nelements;
 228 };
 229
 230 static GTY(()) struct string_pool_data * spd;
 231
 232 /* Save the stringpool data in SPD.  */
 233
 234 void
 235 gt_pch_save_stringpool (void)
 236 {
 237   spd = GGC_NEW (struct string_pool_data);
 238   spd->nslots = ident_hash->nslots;
 239   spd->nelements = ident_hash->nelements;
 240   spd->entries = GGC_NEWVEC (struct ht_identifier *, spd->nslots);
 241   memcpy (spd->entries, ident_hash->entries,
 242           spd->nslots * sizeof (spd->entries[0]));
 243 }
 244
 245 /* Return the stringpool to its state before gt_pch_save_stringpool
 246    was called.  */
 247
 248 void
 249 gt_pch_fixup_stringpool (void)
 250 {
 251 }
 252
 253 /* A PCH file has been restored, which loaded SPD; fill the real hash table
 254    from SPD.  */
 255
 256 void
 257 gt_pch_restore_stringpool (void)
 258 {
 259   ht_load (ident_hash, spd->entries, spd->nslots, spd->nelements, false);
 260   spd = NULL;
 261 }
 262
 263 #include "gt-stringpool.h"