gcc/ggc.h

   1 /* Garbage collection for the GNU compiler.
   2    Copyright (C) 1998 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 #include "gansidecl.h"
  22
  23 /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with
  24    an external gc library that might be linked in.  */
  25
  26 /* Language-specific code defines this variable to be either one (if
  27    it wants garbage collection), or zero (if it does not).  */
  28 extern int ggc_p;
  29
  30 /* These structures are defined in various headers throughout the
  31    compiler.  However, rather than force everyone who includes this
  32    header to include all the headers in which they are declared, we
  33    just forward-declare them here.  */
  34 struct eh_status;
  35 struct emit_status;
  36 struct hash_table;
  37 struct label_node;
  38 struct rtvec_def;
  39 struct stmt_status;
  40 union  tree_node;
  41 struct varasm_status;
  42 struct varray_head_tag;
  43
  44 /* Global roots that are preserved during calls to gc.  */
  45
  46 struct ggc_root
  47 {
  48   struct ggc_root *next;
  49   void *base;
  50   int nelt;
  51   int size;
  52   void (*cb) PROTO ((void *));
  53 };
  54
  55 extern struct ggc_root *roots;
  56
  57 /* Manipulate global roots that are needed between calls to gc.  */
  58 void ggc_add_root PROTO ((void *base, int nelt, int size, void (*)(void *)));
  59 void ggc_add_rtx_root PROTO ((struct rtx_def **, int nelt));
  60 void ggc_add_tree_root PROTO ((union tree_node **, int nelt));
  61 void ggc_add_string_root PROTO ((char **, int nelt));
  62 void ggc_add_tree_varray_root PROTO ((struct varray_head_tag **, int nelt));
  63 void ggc_add_tree_hash_table_root PROTO ((struct hash_table **, int nelt));
  64 void ggc_del_root PROTO ((void *base));
  65
  66 /* Mark nodes from the gc_add_root callback.  These functions follow
  67    pointers to mark other objects too.  */
  68 void ggc_mark_rtx PROTO ((struct rtx_def *));
  69 void ggc_mark_rtvec PROTO ((struct rtvec_def *));
  70 void ggc_mark_tree PROTO ((union tree_node *));
  71 void ggc_mark_tree_varray PROTO ((struct varray_head_tag *));
  72 void ggc_mark_tree_hash_table PROTO ((struct hash_table *));
  73 void ggc_mark_string PROTO ((char *));
  74 void ggc_mark PROTO ((void *));
  75
  76
  77 /* A GC implementation must provide these functions.  */
  78
  79 /* Initialize the garbage collector.   */
  80 extern void init_ggc PROTO ((void));
  81
  82 /* Start a new GGC context.  Memory allocated in previous contexts
  83    will not be collected while the new context is active.  */
  84 extern void ggc_pop_context PROTO ((void));
  85
  86 /* Finish a GC context.  Any uncollected memory in the new context
  87    will be merged with the old context.  */
  88 extern void ggc_push_context PROTO ((void));
  89
  90 /* Allocation.  */
  91 struct rtx_def *ggc_alloc_rtx PROTO ((int nslots));
  92 struct rtvec_def *ggc_alloc_rtvec PROTO ((int nelt));
  93 union tree_node *ggc_alloc_tree PROTO ((int length));
  94 char *ggc_alloc_string PROTO ((const char *contents, int length));
  95 void *ggc_alloc PROTO ((size_t));
  96
  97 /* Invoke the collector.  This is really just a hint, but in the case of
  98    the simple collector, the only time it will happen.  */
  99 void ggc_collect PROTO ((void));
 100
 101 /* Actually set the mark on a particular region of memory, but don't
 102    follow pointers.  These functions are called by ggc_mark_*.  They
 103    return zero if the object was not previously marked; they return
 104    non-zero if the object was already marked, or if, for any other
 105    reason, pointers in this data structure should not be traversed.  */
 106 int ggc_set_mark_rtx PROTO ((struct rtx_def *));
 107 int ggc_set_mark_rtvec PROTO ((struct rtvec_def *));
 108 int ggc_set_mark_tree PROTO ((union tree_node *));
 109
 110
 111 /* Callbacks to the languages.  */
 112
 113 /* This is the language's opportunity to mark nodes held through
 114    the lang_specific hooks in the tree.  */
 115 void lang_mark_tree PROTO ((union tree_node *));
 116
 117 /* The FALSE_LABEL_STACK, declared in except.h, has
 118    language-dependent semantics.  Each front-end should define this
 119    function appropriately.  */
 120 void lang_mark_false_label_stack PROTO ((struct label_node *));
 121
 122 /* Mark functions for various structs scattered about.  */
 123
 124 void mark_eh_state PROTO ((struct eh_status *));
 125 void mark_stmt_state PROTO ((struct stmt_status *));
 126 void mark_emit_state PROTO ((struct emit_status *));
 127 void mark_varasm_state PROTO ((struct varasm_status *));
 128 void mark_optab PROTO ((void *));