/* Garbage collection for the GNU compiler.
- Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+
+ Copyright (C) 1998-2014 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
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. */
/* Constants for general use. */
extern const char empty_string[]; /* empty string */
-extern const char digit_vector[]; /* "0" .. "9" */
-#define digit_string(d) (digit_vector + ((d) * 2))
/* Internal functions and data structures used by the GTY
- machinery. */
-
-/* The first parameter is a pointer to a pointer, the second a cookie. */
-typedef void (*gt_pointer_operator) PARAMS ((void *, void *));
+ machinery, including the generated gt*.[hc] files. */
#include "gtype-desc.h"
/* One of these applies its third parameter (with cookie in the fourth
parameter) to each pointer in the object pointed to by the first
parameter, using the second parameter. */
-typedef void (*gt_note_pointers)
- PARAMS ((void *, void *, gt_pointer_operator, void *));
+typedef void (*gt_note_pointers) (void *, void *, gt_pointer_operator,
+ void *);
/* One of these is called before objects are re-ordered in memory.
The first parameter is the original object, the second is the
subobject that has had its pointers reordered, the third parameter
can compute the new values of a pointer when given the cookie in
the fourth parameter. */
-typedef void (*gt_handle_reorder)
- PARAMS ((void *, void *, gt_pointer_operator, void *));
+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. */
-extern int gt_pch_note_object
- PARAMS ((void *, void *, gt_note_pointers));
+extern int gt_pch_note_object (void *, void *, gt_note_pointers);
-/* Used by the gt_pch_n_* routines. Register that an object has a reorder
+/* Used by the gt_pch_n_* routines. Register that an object has a reorder
function. */
-extern void gt_pch_note_reorder
- PARAMS ((void *, void *, gt_handle_reorder));
+extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder);
/* Mark the object in the first parameter and anything it points to. */
-typedef void (*gt_pointer_walker) PARAMS ((void *));
+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;
size_t stride;
gt_pointer_walker cb;
gt_pointer_walker pchw;
- int (*marked_p) PARAMS ((const void *));
+ int (*marked_p) (const void *);
};
#define LAST_GGC_CACHE_TAB { NULL, 0, 0, NULL, NULL, NULL }
/* Pointers to arrays of ggc_cache_tab, terminated by NULL. */
/* Actually set the mark on a particular region of memory, but don't
follow pointers. This function is called by ggc_mark_*. It
- returns zero if the object was not previously marked; non-zero if
+ returns zero if the object was not previously marked; nonzero if
the object was already marked, or if, for any other reason,
pointers in this data structure should not be traversed. */
-extern int ggc_set_mark PARAMS ((const void *));
+extern int ggc_set_mark (const void *);
/* Return 1 if P has been marked, zero otherwise.
P must have been allocated by the GC allocator; it mustn't point to
static objects, stack variables, or memory allocated with malloc. */
-extern int ggc_marked_p PARAMS ((const void *));
+extern int ggc_marked_p (const void *);
-/* Mark the entries in the string pool. */
-extern void ggc_mark_stringpool PARAMS ((void));
+/* PCH and GGC handling for strings, mostly trivial. */
+extern void gt_pch_n_S (const void *);
+extern void gt_ggc_m_S (const void *);
-/* Call ggc_set_mark on all the roots. */
+/* End of GTY machinery API. */
-extern void ggc_mark_roots PARAMS ((void));
+/* Initialize the string pool. */
+extern void init_stringpool (void);
-/* Save and restore the string pool entries for PCH. */
+/* Initialize the garbage collector. */
+extern void init_ggc (void);
-extern void gt_pch_save_stringpool PARAMS ((void));
-extern void gt_pch_restore_stringpool PARAMS ((void));
+/* When true, identifier nodes are considered as GC roots. When
+ false, identifier nodes are treated like any other GC-allocated
+ object, and the identifier hash table is treated as a weak
+ hash. */
+extern bool ggc_protect_identifiers;
-/* PCH and GGC handling for strings, mostly trivial. */
+/* Write out all GCed objects to F. */
+extern void gt_pch_save (FILE *f);
-extern void gt_pch_p_S PARAMS ((void *, void *,
- gt_pointer_operator, void *));
-extern void gt_pch_n_S PARAMS ((const void *));
-extern void gt_ggc_m_S PARAMS ((void *));
+\f
+/* Allocation. */
-/* Initialise the string pool. */
-extern void init_stringpool PARAMS ((void));
+/* The internal primitive. */
+extern void *ggc_internal_alloc (size_t, void (*)(void *), size_t,
+ size_t CXX_MEM_STAT_INFO)
+ ATTRIBUTE_MALLOC;
-/* A GC implementation must provide these functions. They are internal
- to the GC system. */
+ static inline
+ void *
+ ggc_internal_alloc (size_t s CXX_MEM_STAT_INFO)
+{
+ return ggc_internal_alloc (s, NULL, 0, 1 PASS_MEM_STAT);
+}
-/* Initialize the garbage collector. */
-extern void init_ggc PARAMS ((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 PARAMS ((void));
-
-/* Finish a GC context. Any uncollected memory in the new context
- will be merged with the old context. */
-extern void ggc_pop_context PARAMS ((void));
-
-struct ggc_pch_data;
-
-/* Return a new ggc_pch_data structure. */
-extern struct ggc_pch_data *init_ggc_pch PARAMS ((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
- that information as is necessary. */
-extern void ggc_pch_count_object PARAMS ((struct ggc_pch_data *,
- void *, size_t));
-
-/* Return the total size of the data to be written to hold all
- the objects previously passed to ggc_pch_count_object. */
-extern size_t ggc_pch_total_size PARAMS ((struct ggc_pch_data *));
-
-/* The objects, when read, will most likely be at the address
- in the second parameter. */
-extern void ggc_pch_this_base PARAMS ((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 PARAMS ((struct ggc_pch_data *,
- void *, size_t));
-
-/* Write out any initial information required. */
-extern void ggc_pch_prepare_write PARAMS ((struct ggc_pch_data *,
- FILE *));
-/* Write out this object, including any padding. */
-extern void ggc_pch_write_object PARAMS ((struct ggc_pch_data *,
- FILE *, void *, void *,
- size_t));
-/* All objects have been written, write out any final information
- required. */
-extern void ggc_pch_finish PARAMS ((struct ggc_pch_data *,
- FILE *));
-
-/* A PCH file has just been read in at the address specified second
- parameter. Set up the GC implementation for the new objects. */
-extern void ggc_pch_read PARAMS ((FILE *, void *));
+extern size_t ggc_round_alloc_size (size_t requested_size);
-\f
-/* Allocation. */
+/* Allocates cleared memory. */
+extern void *ggc_internal_cleared_alloc (size_t, void (*)(void *),
+ size_t, size_t
+ CXX_MEM_STAT_INFO) ATTRIBUTE_MALLOC;
+
+static inline
+void *
+ggc_internal_cleared_alloc (size_t s CXX_MEM_STAT_INFO)
+{
+ return ggc_internal_cleared_alloc (s, NULL, 0, 1 PASS_MEM_STAT);
+}
-/* The internal primitive. */
-extern void *ggc_alloc PARAMS ((size_t));
-/* Like ggc_alloc, but allocates cleared memory. */
-extern void *ggc_alloc_cleared PARAMS ((size_t));
/* Resize a block. */
-extern void *ggc_realloc PARAMS ((void *, size_t));
-/* Like ggc_alloc_cleared, but performs a multiplication. */
-extern void *ggc_calloc PARAMS ((size_t, size_t));
+extern void *ggc_realloc (void *, size_t CXX_MEM_STAT_INFO);
+
+/* Free a block. To be used when known for certain it's not reachable. */
+extern void ggc_free (void *);
-#define ggc_alloc_rtx(NSLOTS) \
- ((struct rtx_def *) ggc_alloc (sizeof (struct rtx_def) \
- + ((NSLOTS) - 1) * sizeof (rtunion)))
+extern void dump_ggc_loc_statistics (bool);
+
+/* Reallocator. */
+#define GGC_RESIZEVEC(T, P, N) \
+ ((T *) ggc_realloc ((P), (N) * sizeof (T) MEM_STAT_INFO))
+
+template<typename T>
+void
+finalize (void *p)
+{
+ static_cast<T *> (p)->~T ();
+}
-#define ggc_alloc_rtvec(NELT) \
- ((struct rtvec_def *) ggc_alloc (sizeof (struct rtvec_def) \
- + ((NELT) - 1) * sizeof (rtx)))
+template<typename T>
+static inline bool
+need_finalization_p ()
+{
+#if GCC_VERSION >= 4003
+ return !__has_trivial_destructor (T);
+#else
+ return true;
+#endif
+}
+
+template<typename T>
+static inline T *
+ggc_alloc (ALONE_CXX_MEM_STAT_INFO)
+{
+ if (need_finalization_p<T> ())
+ return static_cast<T *> (ggc_internal_alloc (sizeof (T), finalize<T>, 0, 1
+ PASS_MEM_STAT));
+ else
+ return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1
+ PASS_MEM_STAT));
+}
+
+template<typename T>
+static inline T *
+ggc_cleared_alloc (ALONE_CXX_MEM_STAT_INFO)
+{
+ if (need_finalization_p<T> ())
+ return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T),
+ finalize<T>, 0, 1
+ PASS_MEM_STAT));
+ else
+ return static_cast<T *> (ggc_internal_cleared_alloc (sizeof (T), NULL, 0, 1
+ PASS_MEM_STAT));
+}
+
+template<typename T>
+static inline T *
+ggc_vec_alloc (size_t c CXX_MEM_STAT_INFO)
+{
+ if (need_finalization_p<T> ())
+ return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), finalize<T>,
+ sizeof (T), c PASS_MEM_STAT));
+ else
+ return static_cast<T *> (ggc_internal_alloc (c * sizeof (T), NULL, 0, 0
+ PASS_MEM_STAT));
+}
+
+template<typename T>
+static inline T *
+ggc_cleared_vec_alloc (size_t c CXX_MEM_STAT_INFO)
+{
+ if (need_finalization_p<T> ())
+ return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T),
+ finalize<T>,
+ sizeof (T), c
+ PASS_MEM_STAT));
+ else
+ return static_cast<T *> (ggc_internal_cleared_alloc (c * sizeof (T), NULL,
+ 0, 0 PASS_MEM_STAT));
+}
+
+static inline void *
+ggc_alloc_atomic (size_t s CXX_MEM_STAT_INFO)
+{
+ return ggc_internal_alloc (s PASS_MEM_STAT);
+}
-#define ggc_alloc_tree(LENGTH) ((union tree_node *) ggc_alloc (LENGTH))
+extern void *ggc_cleared_alloc_htab_ignore_args (size_t, size_t)
+ ATTRIBUTE_MALLOC;
+
+extern void *ggc_cleared_alloc_ptr_array_two_args (size_t, size_t)
+ ATTRIBUTE_MALLOC;
#define htab_create_ggc(SIZE, HASH, EQ, DEL) \
- htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL)
+ htab_create_typed_alloc (SIZE, HASH, EQ, DEL, \
+ ggc_cleared_alloc_htab_ignore_args, \
+ ggc_cleared_alloc_ptr_array_two_args, \
+ ggc_free)
+
+#define splay_tree_new_ggc(COMPARE, ALLOC_TREE, ALLOC_NODE) \
+ splay_tree_new_typed_alloc (COMPARE, NULL, NULL, &ALLOC_TREE, &ALLOC_NODE, \
+ &ggc_splay_dont_free, NULL)
-#define splay_tree_new_ggc(COMPARE) \
- splay_tree_new_with_allocator (COMPARE, NULL, NULL, \
- &ggc_splay_alloc, &ggc_splay_dont_free, \
- NULL)
-extern PTR ggc_splay_alloc PARAMS ((int, void *));
-extern void ggc_splay_dont_free PARAMS ((void *, void *));
+extern void *ggc_splay_alloc (int, void *)
+ ATTRIBUTE_MALLOC;
+
+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. */
-extern const char *ggc_alloc_string PARAMS ((const char *contents,
- int length));
+extern const char *ggc_alloc_string (const char *contents, int length
+ CXX_MEM_STAT_INFO);
/* Make a copy of S, in GC-able memory. */
-#define ggc_strdup(S) ggc_alloc_string((S), -1)
+#define ggc_strdup(S) ggc_alloc_string ((S), -1 MEM_STAT_INFO)
/* Invoke the collector. Garbage collection occurs only when this
function is called, not during allocations. */
-extern void ggc_collect PARAMS ((void));
+extern void ggc_collect (void);
-/* Return the number of bytes allocated at the indicated address. */
-extern size_t ggc_get_size PARAMS ((const void *));
+/* Assume that all GGC memory is reachable and grow the limits for next collection. */
+extern void ggc_grow (void);
-/* Write out all GCed objects to F. */
-extern void gt_pch_save PARAMS ((FILE *f));
+/* Register an additional root table. This can be useful for some
+ plugins. Does nothing if the passed pointer is NULL. */
+extern void ggc_register_root_tab (const struct ggc_root_tab *);
+
+/* Register an additional cache table. This can be useful for some
+ plugins. Does nothing if the passed pointer is NULL. */
+extern void ggc_register_cache_tab (const struct ggc_cache_tab *);
/* Read objects previously saved with gt_pch_save from F. */
-extern void gt_pch_restore PARAMS ((FILE *f));
+extern void gt_pch_restore (FILE *f);
\f
/* Statistics. */
-/* This structure contains the statistics common to all collectors.
- Particular collectors can extend this structure. */
-typedef struct ggc_statistics
+/* Print allocation statistics. */
+extern void ggc_print_statistics (void);
+
+extern void stringpool_statistics (void);
+
+/* Heuristics. */
+extern void init_ggc_heuristics (void);
+
+#define ggc_alloc_rtvec_sized(NELT) \
+ (rtvec_def *) ggc_internal_alloc (sizeof (struct rtvec_def) \
+ + ((NELT) - 1) * sizeof (rtx)) \
+
+/* Memory statistics passing versions of some allocators. Too few of them to
+ make gengtype produce them, so just define the needed ones here. */
+static inline struct rtx_def *
+ggc_alloc_rtx_def_stat (size_t s CXX_MEM_STAT_INFO)
{
- /* At present, we don't really gather any interesting statistics. */
- int unused;
-} ggc_statistics;
+ return (struct rtx_def *) ggc_internal_alloc (s PASS_MEM_STAT);
+}
-/* Used by the various collectors to gather and print statistics that
- do not depend on the collector in use. */
-extern void ggc_print_common_statistics PARAMS ((FILE *, ggc_statistics *));
+static inline union tree_node *
+ggc_alloc_tree_node_stat (size_t s CXX_MEM_STAT_INFO)
+{
+ return (union tree_node *) ggc_internal_alloc (s PASS_MEM_STAT);
+}
-/* Print allocation statistics. */
-extern void ggc_print_statistics PARAMS ((void));
-extern void stringpool_statistics PARAMS ((void));
+static inline union tree_node *
+ggc_alloc_cleared_tree_node_stat (size_t s CXX_MEM_STAT_INFO)
+{
+ return (union tree_node *) ggc_internal_cleared_alloc (s PASS_MEM_STAT);
+}
+
+static inline struct gimple_statement_base *
+ggc_alloc_cleared_gimple_statement_stat (size_t s CXX_MEM_STAT_INFO)
+{
+ return (struct gimple_statement_base *)
+ ggc_internal_cleared_alloc (s PASS_MEM_STAT);
+}
+
+static inline void
+gt_ggc_mx (const char *s)
+{
+ ggc_test_and_set_mark (const_cast<char *> (s));
+}
+
+static inline void
+gt_pch_nx (const char *)
+{
+}
+
+static inline void
+gt_ggc_mx (int)
+{
+}
+
+static inline void
+gt_pch_nx (int)
+{
+}
+
+static inline void
+gt_pch_nx (unsigned int)
+{
+}
+
+#endif