gcc/ggc-common.c

   1 /* Simple garbage collection for the GNU compiler.
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3
   4    This file is part of GNU CC.
   5
   6    GNU CC is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    GNU CC is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with GNU CC; see the file COPYING.  If not, write to
  18    the Free Software Foundation, 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 /* Generic garbage collection (GC) functions and data, not specific to
  22    any particular GC implementation.  */
  23
  24 #include "config.h"
  25 #include "system.h"
  26 #include "rtl.h"
  27 #include "tree.h"
  28 #include "tm_p.h"
  29 #include "hash.h"
  30 #include "varray.h"
  31 #include "ggc.h"
  32
  33 /* Statistics about the allocation.  */
  34 static ggc_statistics *ggc_stats;
  35
  36 static void ggc_mark_rtx_ptr PARAMS ((void *));
  37 static void ggc_mark_tree_ptr PARAMS ((void *));
  38 static void ggc_mark_tree_varray_ptr PARAMS ((void *));
  39 static void ggc_mark_tree_hash_table_ptr PARAMS ((void *));
  40 static void ggc_mark_string_ptr PARAMS ((void *));
  41 static boolean ggc_mark_tree_hash_table_entry PARAMS ((struct hash_entry *,
  42                                                        hash_table_key));
  43
  44 /* Maintain global roots that are preserved during GC.  */
  45
  46 /* Global roots that are preserved during calls to gc.  */
  47
  48 struct ggc_root
  49 {
  50   struct ggc_root *next;
  51   void *base;
  52   int nelt;
  53   int size;
  54   void (*cb) PROTO ((void *));
  55 };
  56
  57 static struct ggc_root *roots;
  58
  59 /* Type-correct function to pass to ggc_add_root.  It just forwards
  60    *ELT (which is an rtx) to ggc_mark_tree_varray.  */
  61
  62 static void
  63 ggc_mark_rtx_ptr (elt)
  64      void *elt;
  65 {
  66   ggc_mark_rtx (*(rtx *)elt);
  67 }
  68
  69 /* Type-correct function to pass to ggc_add_root.  It just forwards
  70    *ELT (which is a tree) to ggc_mark_tree.  */
  71
  72 static void
  73 ggc_mark_tree_ptr (elt)
  74      void *elt;
  75 {
  76   ggc_mark_tree (*(tree *)elt);
  77 }
  78
  79 /* Type-correct function to pass to ggc_add_root.  It just forwards
  80    ELT (which is really a varray_type *) to ggc_mark_tree_varray.  */
  81
  82 static void
  83 ggc_mark_tree_varray_ptr (elt)
  84      void *elt;
  85 {
  86   ggc_mark_tree_varray (*(varray_type *)elt);
  87 }
  88
  89 /* Type-correct function to pass to ggc_add_root.  It just forwards
  90    ELT (which is really a struct hash_table **) to
  91    ggc_mark_tree_hash_table.  */
  92
  93 static void
  94 ggc_mark_tree_hash_table_ptr (elt)
  95      void *elt;
  96 {
  97   ggc_mark_tree_hash_table (*(struct hash_table **) elt);
  98 }
  99
 100 /* Type-correct function to pass to ggc_add_root.  It just forwards
 101    ELT (which is really a char **) to ggc_mark_string.  */
 102
 103 static void
 104 ggc_mark_string_ptr (elt)
 105      void *elt;
 106 {
 107   ggc_mark_string (*(char **)elt);
 108 }
 109
 110 /* Add BASE as a new garbage collection root.  It is an array of
 111    length NELT with each element SIZE bytes long.  CB is a
 112    function that will be called with a pointer to each element
 113    of the array; it is the intention that CB call the appropriate
 114    routine to mark gc-able memory for that element.  */
 115
 116 void
 117 ggc_add_root (base, nelt, size, cb)
 118      void *base;
 119      int nelt, size;
 120      void (*cb) PROTO ((void *));
 121 {
 122   struct ggc_root *x = (struct ggc_root *) xmalloc (sizeof (*x));
 123
 124   x->next = roots;
 125   x->base = base;
 126   x->nelt = nelt;
 127   x->size = size;
 128   x->cb = cb;
 129
 130   roots = x;
 131 }
 132
 133 /* Register an array of rtx as a GC root.  */
 134
 135 void
 136 ggc_add_rtx_root (base, nelt)
 137      rtx *base;
 138      int nelt;
 139 {
 140   ggc_add_root (base, nelt, sizeof(rtx), ggc_mark_rtx_ptr);
 141 }
 142
 143 /* Register an array of trees as a GC root.  */
 144
 145 void
 146 ggc_add_tree_root (base, nelt)
 147      tree *base;
 148      int nelt;
 149 {
 150   ggc_add_root (base, nelt, sizeof(tree), ggc_mark_tree_ptr);
 151 }
 152
 153 /* Register a varray of trees as a GC root.  */
 154
 155 void
 156 ggc_add_tree_varray_root (base, nelt)
 157      varray_type *base;
 158      int nelt;
 159 {
 160   ggc_add_root (base, nelt, sizeof (varray_type),
 161                 ggc_mark_tree_varray_ptr);
 162 }
 163
 164 /* Register a hash table of trees as a GC root.  */
 165
 166 void
 167 ggc_add_tree_hash_table_root (base, nelt)
 168      struct hash_table **base;
 169      int nelt;
 170 {
 171   ggc_add_root (base, nelt, sizeof (struct hash_table *),
 172                 ggc_mark_tree_hash_table_ptr);
 173 }
 174
 175 /* Register an array of strings as a GC root.  */
 176
 177 void
 178 ggc_add_string_root (base, nelt)
 179      char **base;
 180      int nelt;
 181 {
 182   ggc_add_root (base, nelt, sizeof (char *), ggc_mark_string_ptr);
 183 }
 184
 185 /* Remove the previously registered GC root at BASE.  */
 186
 187 void
 188 ggc_del_root (base)
 189      void *base;
 190 {
 191   struct ggc_root *x, **p;
 192
 193   p = &roots, x = roots;
 194   while (x)
 195     {
 196       if (x->base == base)
 197         {
 198           *p = x->next;
 199           free (x);
 200           return;
 201         }
 202       p = &x->next;
 203       x = x->next;
 204     }
 205
 206   abort();
 207 }
 208
 209 /* Iterate through all registered roots and mark each element.  */
 210
 211 void
 212 ggc_mark_roots ()
 213 {
 214   struct ggc_root* x;
 215
 216   for (x = roots; x != NULL; x = x->next)
 217     {
 218       char *elt = x->base;
 219       int s = x->size, n = x->nelt;
 220       void (*cb) PROTO ((void *)) = x->cb;
 221       int i;
 222
 223       for (i = 0; i < n; ++i, elt += s)
 224         (*cb)(elt);
 225     }
 226 }
 227
 228 /* R had not been previously marked, but has now been marked via
 229    ggc_set_mark.  Now recurse and process the children.  */
 230
 231 void
 232 ggc_mark_rtx_children (r)
 233      rtx r;
 234 {
 235   const char *fmt;
 236   int i;
 237   enum rtx_code code = GET_CODE (r);
 238
 239   /* Collect statistics, if appropriate.  */
 240   if (ggc_stats)
 241     {
 242       ++ggc_stats->num_rtxs[(int) code];
 243       ggc_stats->size_rtxs[(int) code] += ggc_get_size (r);
 244     }
 245
 246   /* ??? If (some of) these are really pass-dependant info, do we have
 247      any right poking our noses in?  */
 248   switch (code)
 249     {
 250     case JUMP_INSN:
 251       ggc_mark_rtx (JUMP_LABEL (r));
 252       break;
 253     case CODE_LABEL:
 254       ggc_mark_rtx (LABEL_REFS (r));
 255       break;
 256     case LABEL_REF:
 257       ggc_mark_rtx (LABEL_NEXTREF (r));
 258       ggc_mark_rtx (CONTAINING_INSN (r));
 259       break;
 260     case ADDRESSOF:
 261       ggc_mark_tree (ADDRESSOF_DECL (r));
 262       break;
 263     case CONST_DOUBLE:
 264       ggc_mark_rtx (CONST_DOUBLE_CHAIN (r));
 265       break;
 266     case NOTE:
 267       switch (NOTE_LINE_NUMBER (r))
 268         {
 269         case NOTE_INSN_RANGE_START:
 270         case NOTE_INSN_RANGE_END:
 271         case NOTE_INSN_LIVE:
 272           ggc_mark_rtx (NOTE_RANGE_INFO (r));
 273           break;
 274
 275         case NOTE_INSN_BLOCK_BEG:
 276         case NOTE_INSN_BLOCK_END:
 277           ggc_mark_tree (NOTE_BLOCK (r));
 278           break;
 279
 280         default:
 281           if (NOTE_LINE_NUMBER (r) >= 0)
 282             ggc_mark_string (NOTE_SOURCE_FILE (r));
 283           break;
 284         }
 285       break;
 286
 287     default:
 288       break;
 289     }
 290
 291   for (fmt = GET_RTX_FORMAT (GET_CODE (r)), i = 0; *fmt ; ++fmt, ++i)
 292     {
 293       switch (*fmt)
 294         {
 295         case 'e': case 'u':
 296           ggc_mark_rtx (XEXP (r, i));
 297           break;
 298         case 'V': case 'E':
 299           ggc_mark_rtvec (XVEC (r, i));
 300           break;
 301         case 'S': case 's':
 302           ggc_mark_if_gcable (XSTR (r, i));
 303           break;
 304         }
 305     }
 306 }
 307
 308 /* V had not been previously marked, but has now been marked via
 309    ggc_set_mark.  Now recurse and process the children.  */
 310
 311 void
 312 ggc_mark_rtvec_children (v)
 313      rtvec v;
 314 {
 315   int i;
 316
 317   i = GET_NUM_ELEM (v);
 318   while (--i >= 0)
 319     ggc_mark_rtx (RTVEC_ELT (v, i));
 320 }
 321
 322 /* T had not been previously marked, but has now been marked via
 323    ggc_set_mark.  Now recurse and process the children.  */
 324
 325 void
 326 ggc_mark_tree_children (t)
 327      tree t;
 328 {
 329   enum tree_code code = TREE_CODE (t);
 330
 331   /* Collect statistics, if appropriate.  */
 332   if (ggc_stats)
 333     {
 334       ++ggc_stats->num_trees[(int) code];
 335       ggc_stats->size_trees[(int) code] += ggc_get_size (t);
 336     }
 337
 338   /* Bits from common.  */
 339   ggc_mark_tree (TREE_TYPE (t));
 340   ggc_mark_tree (TREE_CHAIN (t));
 341
 342   /* Some nodes require special handling.  */
 343   switch (code)
 344     {
 345     case TREE_LIST:
 346       ggc_mark_tree (TREE_PURPOSE (t));
 347       ggc_mark_tree (TREE_VALUE (t));
 348       return;
 349
 350     case TREE_VEC:
 351       {
 352         int i = TREE_VEC_LENGTH (t);
 353         while (--i >= 0)
 354           ggc_mark_tree (TREE_VEC_ELT (t, i));
 355         return;
 356       }
 357
 358     case SAVE_EXPR:
 359       ggc_mark_tree (TREE_OPERAND (t, 0));
 360       ggc_mark_tree (SAVE_EXPR_CONTEXT (t));
 361       ggc_mark_rtx (SAVE_EXPR_RTL (t));
 362       return;
 363
 364     case RTL_EXPR:
 365       ggc_mark_rtx (RTL_EXPR_SEQUENCE (t));
 366       ggc_mark_rtx (RTL_EXPR_RTL (t));
 367       return;
 368
 369     case CALL_EXPR:
 370       ggc_mark_tree (TREE_OPERAND (t, 0));
 371       ggc_mark_tree (TREE_OPERAND (t, 1));
 372       ggc_mark_rtx (CALL_EXPR_RTL (t));
 373       return;
 374
 375     case COMPLEX_CST:
 376       ggc_mark_tree (TREE_REALPART (t));
 377       ggc_mark_tree (TREE_IMAGPART (t));
 378       break;
 379
 380     case STRING_CST:
 381       ggc_mark_string (TREE_STRING_POINTER (t));
 382       break;
 383
 384     case PARM_DECL:
 385       ggc_mark_rtx (DECL_INCOMING_RTL (t));
 386       break;
 387
 388     case IDENTIFIER_NODE:
 389       ggc_mark_string (IDENTIFIER_POINTER (t));
 390       lang_mark_tree (t);
 391       return;
 392
 393     default:
 394       break;
 395     }
 396
 397   /* But in general we can handle them by class.  */
 398   switch (TREE_CODE_CLASS (code))
 399     {
 400     case 'd': /* A decl node.  */
 401       ggc_mark_string (DECL_SOURCE_FILE (t));
 402       ggc_mark_tree (DECL_SIZE (t));
 403       ggc_mark_tree (DECL_NAME (t));
 404       ggc_mark_tree (DECL_CONTEXT (t));
 405       ggc_mark_tree (DECL_ARGUMENTS (t));
 406       ggc_mark_tree (DECL_RESULT (t));
 407       ggc_mark_tree (DECL_INITIAL (t));
 408       ggc_mark_tree (DECL_ABSTRACT_ORIGIN (t));
 409       ggc_mark_tree (DECL_ASSEMBLER_NAME (t));
 410       ggc_mark_tree (DECL_SECTION_NAME (t));
 411       ggc_mark_tree (DECL_MACHINE_ATTRIBUTES (t));
 412       ggc_mark_rtx (DECL_RTL (t));
 413       ggc_mark_rtx (DECL_LIVE_RANGE_RTL (t));
 414       ggc_mark_tree (DECL_VINDEX (t));
 415       lang_mark_tree (t);
 416       break;
 417
 418     case 't': /* A type node.  */
 419       ggc_mark_tree (TYPE_SIZE (t));
 420       ggc_mark_tree (TYPE_SIZE_UNIT (t));
 421       ggc_mark_tree (TYPE_ATTRIBUTES (t));
 422       ggc_mark_tree (TYPE_VALUES (t));
 423       ggc_mark_tree (TYPE_POINTER_TO (t));
 424       ggc_mark_tree (TYPE_REFERENCE_TO (t));
 425       ggc_mark_tree (TYPE_NAME (t));
 426       ggc_mark_tree (TYPE_MIN_VALUE (t));
 427       ggc_mark_tree (TYPE_MAX_VALUE (t));
 428       ggc_mark_tree (TYPE_NEXT_VARIANT (t));
 429       ggc_mark_tree (TYPE_MAIN_VARIANT (t));
 430       ggc_mark_tree (TYPE_BINFO (t));
 431       ggc_mark_tree (TYPE_NONCOPIED_PARTS (t));
 432       ggc_mark_tree (TYPE_CONTEXT (t));
 433       lang_mark_tree (t);
 434       break;
 435
 436     case 'b': /* A lexical block.  */
 437       ggc_mark_tree (BLOCK_VARS (t));
 438       ggc_mark_tree (BLOCK_SUBBLOCKS (t));
 439       ggc_mark_tree (BLOCK_SUPERCONTEXT (t));
 440       ggc_mark_tree (BLOCK_ABSTRACT_ORIGIN (t));
 441       break;
 442
 443     case 'c': /* A constant.  */
 444       ggc_mark_rtx (TREE_CST_RTL (t));
 445       break;
 446
 447     case 'r': case '<': case '1':
 448     case '2': case 'e': case 's': /* Expressions.  */
 449       {
 450         int i = tree_code_length[TREE_CODE (t)];
 451         while (--i >= 0)
 452           ggc_mark_tree (TREE_OPERAND (t, i));
 453         break;
 454       }
 455
 456     case 'x':
 457       lang_mark_tree (t);
 458       break;
 459     }
 460 }
 461
 462 /* Mark all the elements of the varray V, which contains trees.  */
 463
 464 void
 465 ggc_mark_tree_varray (v)
 466      varray_type v;
 467 {
 468   int i;
 469
 470   if (v)
 471     for (i = v->num_elements - 1; i >= 0; --i)
 472       ggc_mark_tree (VARRAY_TREE (v, i));
 473 }
 474
 475 /* Mark the hash table-entry HE.  It's key field is really a tree.  */
 476
 477 static boolean
 478 ggc_mark_tree_hash_table_entry (he, k)
 479      struct hash_entry *he;
 480      hash_table_key k ATTRIBUTE_UNUSED;
 481 {
 482   ggc_mark_tree ((tree) he->key);
 483   return true;
 484 }
 485
 486 /* Mark all the elements of the hash-table H, which contains trees.  */
 487
 488 void
 489 ggc_mark_tree_hash_table (ht)
 490      struct hash_table *ht;
 491 {
 492   hash_traverse (ht, ggc_mark_tree_hash_table_entry, /*info=*/0);
 493 }
 494
 495 /* Allocate a gc-able string.  If CONTENTS is null, then the memory will
 496    be uninitialized.  If LENGTH is -1, then CONTENTS is assumed to be a
 497    null-terminated string and the memory sized accordingly.  Otherwise,
 498    the memory is filled with LENGTH bytes from CONTENTS.  */
 499
 500 char *
 501 ggc_alloc_string (contents, length)
 502      const char *contents;
 503      int length;
 504 {
 505   char *string;
 506
 507   if (length < 0)
 508     {
 509       if (contents == NULL)
 510         return NULL;
 511       length = strlen (contents);
 512     }
 513
 514   string = (char *) ggc_alloc_obj (length + 1, 0);
 515   if (contents != NULL)
 516     memcpy (string, contents, length);
 517   string[length] = 0;
 518
 519   return string;
 520 }
 521
 522 /* Print statistics that are independent of the collector in use.  */
 523
 524 void
 525 ggc_print_statistics (stream, stats)
 526      FILE *stream;
 527      ggc_statistics *stats;
 528 {
 529   int code;
 530
 531   /* Set the pointer so that during collection we will actually gather
 532      the statistics.  */
 533   ggc_stats = stats;
 534
 535   /* Then do one collection to fill in the statistics.  */
 536   ggc_collect ();
 537
 538   /* Total the statistics.  */
 539   for (code = 0; code < MAX_TREE_CODES; ++code)
 540     {
 541       stats->total_num_trees += stats->num_trees[code];
 542       stats->total_size_trees += stats->size_trees[code];
 543     }
 544   for (code = 0; code < NUM_RTX_CODE; ++code)
 545     {
 546       stats->total_num_rtxs += stats->num_rtxs[code];
 547       stats->total_size_rtxs += stats->size_rtxs[code];
 548     }
 549
 550   /* Print the statistics for trees.  */
 551   fprintf (stream, "%-22s%-16s%-16s%-7s\n", "Code",
 552            "Number", "Bytes", "% Total");
 553   for (code = 0; code < MAX_TREE_CODES; ++code)
 554     if (ggc_stats->num_trees[code])
 555       {
 556         fprintf (stream, "%s%*s%-15u %-15lu %7.3f\n",
 557                  tree_code_name[code],
 558                  22 - (int) strlen (tree_code_name[code]), "",
 559                  ggc_stats->num_trees[code],
 560                  (unsigned long) ggc_stats->size_trees[code],
 561                  (100 * ((double) ggc_stats->size_trees[code])
 562                   / ggc_stats->total_size_trees));
 563       }
 564   fprintf (stream,
 565            "%-22s%-15u %-15u\n", "Total",
 566            ggc_stats->total_num_trees,
 567            ggc_stats->total_size_trees);
 568
 569   /* Print the statistics for RTL.  */
 570   fprintf (stream, "\n%-22s%-16s%-16s%-7s\n", "Code",
 571            "Number", "Bytes", "% Total");
 572   for (code = 0; code < NUM_RTX_CODE; ++code)
 573     if (ggc_stats->num_rtxs[code])
 574       {
 575         fprintf (stream, "%s%*s%-15u %-15lu %7.3f\n",
 576                  rtx_name[code],
 577                  22 - (int) strlen (rtx_name[code]), "",
 578                  ggc_stats->num_rtxs[code],
 579                  (unsigned long) ggc_stats->size_rtxs[code],
 580                  (100 * ((double) ggc_stats->size_rtxs[code])
 581                   / ggc_stats->total_size_rtxs));
 582       }
 583   fprintf (stream,
 584            "%-22s%-15u %-15u\n", "Total",
 585            ggc_stats->total_num_rtxs,
 586            ggc_stats->total_size_rtxs);
 587
 588
 589   /* Don't gather statistics any more.  */
 590   ggc_stats = NULL;
 591 }