2008-03-04 Rafael Espindola <espindola@google.com>

[pf3gnuchains/gcc-fork.git] / gcc / ggc.h

diff --git a/gcc/ggc.h b/gcc/ggc.h
index e2a76e5..e70afcf 100644 (file)
--- a/gcc/ggc.h
+++ b/gcc/ggc.h
@@ -1,12 +1,12 @@
 /* Garbage collection for the GNU compiler.
 /* Garbage collection for the GNU compiler.

-   Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
+   Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007

    Free Software Foundation, Inc.
 
 This file is part of GCC.
 
 GCC is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
    Free Software Foundation, Inc.
 
 This file is part of GCC.
 
 GCC is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free

-Software Foundation; either version 2, or (at your option) any later
+Software Foundation; either version 3, or (at your option) any later

 version.
 
 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
 version.
 
 GCC is distributed in the hope that it will be useful, but WITHOUT ANY


@@ -15,9 +15,12 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License

-along with GCC; see the file COPYING.  If not, write to the Free
-Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.  */
+along with GCC; see the file COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
+
+#ifndef GCC_GGC_H
+#define GCC_GGC_H
+#include "statistics.h"

 
 /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with
    an external gc library that might be linked in.  */
 
 /* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with
    an external gc library that might be linked in.  */


@@ -50,7 +53,8 @@ typedef void (*gt_handle_reorder) (void *, void *, gt_pointer_operator,
                                   void *);
 
 /* Used by the gt_pch_n_* routines.  Register an object in the hash table.  */
                                   void *);
 
 /* Used by the gt_pch_n_* routines.  Register an object in the hash table.  */

-extern int gt_pch_note_object (void *, void *, gt_note_pointers);
+extern int gt_pch_note_object (void *, void *, gt_note_pointers,
+                              enum gt_types_enum);

 
 /* Used by the gt_pch_n_* routines.  Register that an object has a reorder
    function.  */
 
 /* Used by the gt_pch_n_* routines.  Register that an object has a reorder
    function.  */


@@ -60,7 +64,7 @@ extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder);
 typedef void (*gt_pointer_walker) (void *);
 
 /* Structures for the easy way to mark roots.
 typedef void (*gt_pointer_walker) (void *);
 
 /* Structures for the easy way to mark roots.

-   In an array, terminated by having base == NULL.*/
+   In an array, terminated by having base == NULL.  */

 struct ggc_root_tab {
   void *base;
   size_t nelt;
 struct ggc_root_tab {
   void *base;
   size_t nelt;


@@ -132,22 +136,23 @@ extern void gt_pch_p_S (void *, void *, gt_pointer_operator, void *);
 extern void gt_pch_n_S (const void *);
 extern void gt_ggc_m_S (void *);
 
 extern void gt_pch_n_S (const void *);
 extern void gt_ggc_m_S (void *);
 

-/* Initialise the string pool.  */
+/* Initialize the string pool.  */

 extern void init_stringpool (void);
 
 /* A GC implementation must provide these functions.  They are internal
    to the GC system.  */
 
 extern void init_stringpool (void);
 
 /* A GC implementation must provide these functions.  They are internal
    to the GC system.  */
 

+/* Forward declare the zone structure.  Only ggc_zone implements this.  */
+struct alloc_zone;
+

 /* Initialize the garbage collector.  */
 extern void init_ggc (void);
 
 /* Initialize the garbage collector.  */
 extern void init_ggc (void);
 

-/* Start a new GGC context.  Memory allocated in previous contexts
-   will not be collected while the new context is active.  */
-extern void ggc_push_context (void);
+/* Start a new GGC zone.  */
+extern struct alloc_zone *new_ggc_zone (const char *);

 
 

-/* Finish a GC context.  Any uncollected memory in the new context
-   will be merged with the old context.  */
-extern void ggc_pop_context (void);
+/* Free a complete GGC zone, destroying everything in it.  */
+extern void destroy_ggc_zone (struct alloc_zone *);

 
 struct ggc_pch_data;
 
 
 struct ggc_pch_data;
 


@@ -156,8 +161,10 @@ extern struct ggc_pch_data *init_ggc_pch (void);
 
 /* The second parameter and third parameters give the address and size
    of an object.  Update the ggc_pch_data structure with as much of
 
 /* The second parameter and third parameters give the address and size
    of an object.  Update the ggc_pch_data structure with as much of

-   that information as is necessary.  */
-extern void ggc_pch_count_object (struct ggc_pch_data *, void *, size_t);
+   that information as is necessary. The bool argument should be true
+   if the object is a string.  */
+extern void ggc_pch_count_object (struct ggc_pch_data *, void *, size_t, bool,
+                                 enum gt_types_enum);

 
 /* Return the total size of the data to be written to hold all
    the objects previously passed to ggc_pch_count_object.  */
 
 /* Return the total size of the data to be written to hold all
    the objects previously passed to ggc_pch_count_object.  */


@@ -168,14 +175,17 @@ extern size_t ggc_pch_total_size (struct ggc_pch_data *);
 extern void ggc_pch_this_base (struct ggc_pch_data *, void *);
 
 /* Assuming that the objects really do end up at the address
 extern void ggc_pch_this_base (struct ggc_pch_data *, void *);
 
 /* Assuming that the objects really do end up at the address

-   passed to ggc_pch_this_base, return the address of this object.  */
-extern char *ggc_pch_alloc_object (struct ggc_pch_data *, void *, size_t);
+   passed to ggc_pch_this_base, return the address of this object.
+   The bool argument should be true if the object is a string.  */
+extern char *ggc_pch_alloc_object (struct ggc_pch_data *, void *, size_t, bool,
+                                  enum gt_types_enum);

 
 /* Write out any initial information required.  */
 extern void ggc_pch_prepare_write (struct ggc_pch_data *, FILE *);
 
 /* Write out any initial information required.  */
 extern void ggc_pch_prepare_write (struct ggc_pch_data *, FILE *);

-/* Write out this object, including any padding.  */
+/* Write out this object, including any padding.  The last argument should be
+   true if the object is a string.  */

 extern void ggc_pch_write_object (struct ggc_pch_data *, FILE *, void *,
 extern void ggc_pch_write_object (struct ggc_pch_data *, FILE *, void *,

-                                 void *, size_t);
+                                 void *, size_t, bool);

 /* All objects have been written, write out any final information
    required.  */
 extern void ggc_pch_finish (struct ggc_pch_data *, FILE *);
 /* All objects have been written, write out any final information
    required.  */
 extern void ggc_pch_finish (struct ggc_pch_data *, FILE *);


@@ -187,24 +197,46 @@ extern void ggc_pch_read (FILE *, void *);
 \f
 /* Allocation.  */
 
 \f
 /* Allocation.  */
 

+/* When set, ggc_collect will do collection.  */
+extern bool ggc_force_collect;
+

 /* The internal primitive.  */
 /* The internal primitive.  */

-extern void *ggc_alloc (size_t);
+extern void *ggc_alloc_stat (size_t MEM_STAT_DECL);
+#define ggc_alloc(s) ggc_alloc_stat (s MEM_STAT_INFO)
+/* Allocate an object of the specified type and size.  */
+extern void *ggc_alloc_typed_stat (enum gt_types_enum, size_t MEM_STAT_DECL);
+#define ggc_alloc_typed(s,z) ggc_alloc_typed_stat (s,z MEM_STAT_INFO)

 /* Like ggc_alloc, but allocates cleared memory.  */
 /* Like ggc_alloc, but allocates cleared memory.  */

-extern void *ggc_alloc_cleared (size_t);
+extern void *ggc_alloc_cleared_stat (size_t MEM_STAT_DECL);
+#define ggc_alloc_cleared(s) ggc_alloc_cleared_stat (s MEM_STAT_INFO)

 /* Resize a block.  */
 /* Resize a block.  */

-extern void *ggc_realloc (void *, size_t);
+extern void *ggc_realloc_stat (void *, size_t MEM_STAT_DECL);
+#define ggc_realloc(s,z) ggc_realloc_stat (s,z MEM_STAT_INFO)

 /* Like ggc_alloc_cleared, but performs a multiplication.  */
 extern void *ggc_calloc (size_t, size_t);
 /* Like ggc_alloc_cleared, but performs a multiplication.  */
 extern void *ggc_calloc (size_t, size_t);

-
-#define ggc_alloc_rtx(NSLOTS)                                            \
-  ((struct rtx_def *) ggc_alloc (sizeof (struct rtx_def)                 \
-                                + ((NSLOTS) - 1) * sizeof (rtunion)))
-
-#define ggc_alloc_rtvec(NELT)                                            \
-  ((struct rtvec_def *) ggc_alloc (sizeof (struct rtvec_def)             \
-                                  + ((NELT) - 1) * sizeof (rtx)))
-
-#define ggc_alloc_tree(LENGTH) ((union tree_node *) ggc_alloc (LENGTH))
+/* Free a block.  To be used when known for certain it's not reachable.  */
+extern void ggc_free (void *);
+ 
+extern void ggc_record_overhead (size_t, size_t, void * MEM_STAT_DECL);
+extern void ggc_free_overhead (void *);
+extern void ggc_prune_overhead_list (void);
+
+extern void dump_ggc_loc_statistics (bool);
+
+/* Type-safe, C++-friendly versions of ggc_alloc() and gcc_calloc().  */
+#define GGC_NEW(T)             ((T *) ggc_alloc (sizeof (T)))
+#define GGC_CNEW(T)            ((T *) ggc_alloc_cleared (sizeof (T)))
+#define GGC_NEWVEC(T, N)       ((T *) ggc_alloc ((N) * sizeof(T)))
+#define GGC_CNEWVEC(T, N)      ((T *) ggc_alloc_cleared ((N) * sizeof(T)))
+#define GGC_NEWVAR(T, S)       ((T *) ggc_alloc ((S)))
+#define GGC_CNEWVAR(T, S)      ((T *) ggc_alloc_cleared ((S)))
+#define GGC_RESIZEVEC(T, P, N)  ((T *) ggc_realloc ((P), (N) * sizeof (T)))
+
+#define ggc_alloc_rtvec(NELT)                                           \
+  ((rtvec) ggc_alloc_zone (sizeof (struct rtvec_def) + ((NELT) - 1)     \
+                          * sizeof (rtx), &rtl_zone))
+
+#define ggc_alloc_tree(LENGTH) ((tree) ggc_alloc_zone (LENGTH, &tree_zone))

 
 #define htab_create_ggc(SIZE, HASH, EQ, DEL) \
   htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL)
 
 #define htab_create_ggc(SIZE, HASH, EQ, DEL) \
   htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL)


@@ -219,8 +251,7 @@ extern void ggc_splay_dont_free (void *, void *);
 /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS.
    If LENGTH is -1, then CONTENTS is assumed to be a
    null-terminated string and the memory sized accordingly.  */
 /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS.
    If LENGTH is -1, then CONTENTS is assumed to be a
    null-terminated string and the memory sized accordingly.  */

-extern const char *ggc_alloc_string    PARAMS ((const char *contents,
-                                                int length));
+extern const char *ggc_alloc_string (const char *contents, int length);

 
 /* Make a copy of S, in GC-able memory.  */
 #define ggc_strdup(S) ggc_alloc_string((S), -1)
 
 /* Make a copy of S, in GC-able memory.  */
 #define ggc_strdup(S) ggc_alloc_string((S), -1)


@@ -260,3 +291,26 @@ extern void stringpool_statistics (void);
 extern int ggc_min_expand_heuristic (void);
 extern int ggc_min_heapsize_heuristic (void);
 extern void init_ggc_heuristics (void);
 extern int ggc_min_expand_heuristic (void);
 extern int ggc_min_heapsize_heuristic (void);
 extern void init_ggc_heuristics (void);

+
+/* Zone collection.  */
+#if defined (GGC_ZONE) && !defined (GENERATOR_FILE)
+
+/* For regular rtl allocations.  */
+extern struct alloc_zone rtl_zone;
+/* For regular tree allocations.  */
+extern struct alloc_zone tree_zone;
+/* For IDENTIFIER_NODE allocations.  */
+extern struct alloc_zone tree_id_zone;
+
+/* Allocate an object into the specified allocation zone.  */
+extern void *ggc_alloc_zone_stat (size_t, struct alloc_zone * MEM_STAT_DECL);
+# define ggc_alloc_zone(s,z) ggc_alloc_zone_stat (s,z MEM_STAT_INFO)
+# define ggc_alloc_zone_pass_stat(s,z) ggc_alloc_zone_stat (s,z PASS_MEM_STAT)
+#else
+
+# define ggc_alloc_zone(s, z) ggc_alloc (s)
+# define ggc_alloc_zone_pass_stat(s, z) ggc_alloc_stat (s PASS_MEM_STAT)
+
+#endif
+
+#endif