/* Garbage collection for the GNU compiler.
- Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
- Free Software Foundation, Inc.
+
+ Copyright (C) 1998-2020 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
/* 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) (void *, void *);
+ machinery, including the generated gt*.[hc] files. */
#include "gtype-desc.h"
function. */
extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder);
+/* generated function to clear caches in gc memory. */
+extern void gt_clear_caches ();
+
/* Mark the object in the first parameter and anything it points to. */
typedef void (*gt_pointer_walker) (void *);
/* Pointers to arrays of ggc_root_tab, terminated by NULL. */
extern const struct ggc_root_tab * const gt_ggc_rtab[];
extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[];
-extern const struct ggc_root_tab * const gt_pch_cache_rtab[];
extern const struct ggc_root_tab * const gt_pch_scalar_rtab[];
-/* Structure for hash table cache marking. */
-struct htab;
-struct ggc_cache_tab {
- struct htab * *base;
- size_t nelt;
- size_t stride;
- gt_pointer_walker cb;
- gt_pointer_walker pchw;
- 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. */
-extern const struct ggc_cache_tab * const gt_ggc_cache_rtab[];
-
/* If EXPR is not NULL and previously unmarked, mark it and evaluate
to true. Otherwise evaluate to false. */
#define ggc_test_and_set_mark(EXPR) \
static objects, stack variables, or memory allocated with malloc. */
extern int ggc_marked_p (const void *);
-/* Mark the entries in the string pool. */
-extern void ggc_mark_stringpool (void);
-
-/* Call ggc_set_mark on all the roots. */
-
-extern void ggc_mark_roots (void);
-
-/* Save and restore the string pool entries for PCH. */
-
-extern void gt_pch_save_stringpool (void);
-extern void gt_pch_fixup_stringpool (void);
-extern void gt_pch_restore_stringpool (void);
-
/* PCH and GGC handling for strings, mostly trivial. */
-
-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_ggc_m_S (const void *);
+
+/* End of GTY machinery API. */
/* Initialize the string pool. */
extern void init_stringpool (void);
-/* A GC implementation must provide these functions. They are internal
- to the GC system. */
-
/* 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);
+/* 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;
-/* Finish a GC context. Any uncollected memory in the new context
- will be merged with the old context. */
-extern void ggc_pop_context (void);
+/* Write out all GCed objects to F. */
+extern void gt_pch_save (FILE *f);
-struct ggc_pch_data;
+\f
+/* Allocation. */
-/* Return a new ggc_pch_data structure. */
-extern struct ggc_pch_data *init_ggc_pch (void);
+/* The internal primitive. */
+extern void *ggc_internal_alloc (size_t, void (*)(void *), size_t,
+ size_t CXX_MEM_STAT_INFO)
+ ATTRIBUTE_MALLOC;
-/* 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. The last argument should be true
- if the object is a string. */
-extern void ggc_pch_count_object (struct ggc_pch_data *, void *, size_t, bool);
+inline void *
+ggc_internal_alloc (size_t s CXX_MEM_STAT_INFO)
+{
+ return ggc_internal_alloc (s, NULL, 0, 1 PASS_MEM_STAT);
+}
-/* 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 (struct ggc_pch_data *);
+extern size_t ggc_round_alloc_size (size_t requested_size);
-/* The objects, when read, will most likely be at the address
- in the second parameter. */
-extern void ggc_pch_this_base (struct ggc_pch_data *, void *);
+/* Allocates cleared memory. */
+extern void *ggc_internal_cleared_alloc (size_t, void (*)(void *),
+ size_t, size_t
+ CXX_MEM_STAT_INFO) ATTRIBUTE_MALLOC;
-/* Assuming that the objects really do end up at the address
- passed to ggc_pch_this_base, return the address of this object.
- The last argument should be true if the object is a string. */
-extern char *ggc_pch_alloc_object (struct ggc_pch_data *, void *, size_t, bool);
+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);
+}
-/* Write out any initial information required. */
-extern void ggc_pch_prepare_write (struct ggc_pch_data *, FILE *);
-/* 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 *,
- 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 *);
+/* Resize a block. */
+extern void *ggc_realloc (void *, size_t CXX_MEM_STAT_INFO);
-/* 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 (FILE *, void *);
+/* Free a block. To be used when known for certain it's not reachable. */
+extern void ggc_free (void *);
-\f
-/* Allocation. */
+extern void dump_ggc_loc_statistics ();
-/* Zone structure. */
-struct alloc_zone;
-/* For single pass garbage. */
-extern struct alloc_zone *garbage_zone;
-/* For regular rtl allocations. */
-extern struct alloc_zone *rtl_zone;
-/* For regular tree allocations. */
-extern struct alloc_zone *tree_zone;
+/* Reallocator. */
+#define GGC_RESIZEVEC(T, P, N) \
+ ((T *) ggc_realloc ((P), (N) * sizeof (T) MEM_STAT_INFO))
-/* The internal primitive. */
-extern void *ggc_alloc (size_t);
-/* Allocate an object into the specified allocation zone. */
-extern void *ggc_alloc_zone (size_t, struct alloc_zone *);
-/* Allocate an object of the specified type and size. */
-extern void *ggc_alloc_typed (enum gt_types_enum, size_t);
-/* Like ggc_alloc, but allocates cleared memory. */
-extern void *ggc_alloc_cleared (size_t);
-/* Like ggc_alloc_zone, but allocates cleared memory. */
-extern void *ggc_alloc_cleared_zone (size_t, struct alloc_zone *);
-/* Resize a block. */
-extern void *ggc_realloc (void *, size_t);
-/* Like ggc_alloc_cleared, but performs a multiplication. */
-extern void *ggc_calloc (size_t, size_t);
+template<typename T>
+void
+finalize (void *p)
+{
+ static_cast<T *> (p)->~T ();
+}
-#define ggc_alloc_rtx(CODE) \
- ((rtx) ggc_alloc_typed (gt_ggc_e_7rtx_def, RTX_SIZE (CODE)))
+template<typename T>
+inline bool
+need_finalization_p ()
+{
+#if GCC_VERSION >= 4003
+ return !__has_trivial_destructor (T);
+#else
+ return true;
+#endif
+}
-#define ggc_alloc_rtvec(NELT) \
- ((rtvec) ggc_alloc_typed (gt_ggc_e_9rtvec_def, sizeof (struct rtvec_def) \
- + ((NELT) - 1) * sizeof (rtx)))
+template<typename T>
+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));
+}
+
+/* GGC allocation function that does not call finalizer for type
+ that have need_finalization_p equal to true. User is responsible
+ for calling of the destructor. */
+
+template<typename T>
+inline T *
+ggc_alloc_no_dtor (ALONE_CXX_MEM_STAT_INFO)
+{
+ return static_cast<T *> (ggc_internal_alloc (sizeof (T), NULL, 0, 1
+ PASS_MEM_STAT));
+}
-#define ggc_alloc_tree(LENGTH) ((tree) ggc_alloc_zone (LENGTH, tree_zone))
+template<typename T>
+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>
+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>
+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));
+}
+
+inline void *
+ggc_alloc_atomic (size_t s CXX_MEM_STAT_INFO)
+{
+ return ggc_internal_alloc (s PASS_MEM_STAT);
+}
-#define htab_create_ggc(SIZE, HASH, EQ, DEL) \
- htab_create_alloc (SIZE, HASH, EQ, DEL, ggc_calloc, NULL)
+/* Call destructor and free the garbage collected memory. */
-#define splay_tree_new_ggc(COMPARE) \
- splay_tree_new_with_allocator (COMPARE, NULL, NULL, \
- &ggc_splay_alloc, &ggc_splay_dont_free, \
- NULL)
-extern void *ggc_splay_alloc (int, void *);
-extern void ggc_splay_dont_free (void *, void *);
+template <typename T>
+inline void
+ggc_delete (T *ptr)
+{
+ ptr->~T ();
+ ggc_free (ptr);
+}
/* 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 (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 (void);
-/* Return the number of bytes allocated at the indicated address. */
-extern size_t ggc_get_size (const void *);
+/* Return unused memory pages to the system. */
+extern void ggc_trim (void);
-/* Write out all GCed objects to F. */
-extern void gt_pch_save (FILE *f);
+/* Assume that all GGC memory is reachable and grow the limits for next collection. */
+extern void ggc_grow (void);
+
+/* 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 *);
/* Read objects previously saved with gt_pch_save from 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
-{
- /* At present, we don't really gather any interesting statistics. */
- int unused;
-} ggc_statistics;
-
-/* 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 (FILE *, ggc_statistics *);
-
/* Print allocation statistics. */
extern void ggc_print_statistics (void);
+
extern void stringpool_statistics (void);
/* Heuristics. */
-extern int ggc_min_expand_heuristic (void);
-extern int ggc_min_heapsize_heuristic (void);
extern void init_ggc_heuristics (void);
+/* Report current heap memory use to stderr. */
+extern void report_heap_memory_use (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. */
+inline struct rtx_def *
+ggc_alloc_rtx_def_stat (size_t s CXX_MEM_STAT_INFO)
+{
+ return (struct rtx_def *) ggc_internal_alloc (s PASS_MEM_STAT);
+}
+
+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);
+}
+
+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);
+}
+
+inline gimple *
+ggc_alloc_cleared_gimple_statement_stat (size_t s CXX_MEM_STAT_INFO)
+{
+ return (gimple *) ggc_internal_cleared_alloc (s PASS_MEM_STAT);
+}
+
+inline void
+gt_ggc_mx (const char *s)
+{
+ ggc_test_and_set_mark (const_cast<char *> (s));
+}
+
+inline void
+gt_pch_nx (const char *)
+{
+}
+
+inline void
+gt_ggc_mx (int)
+{
+}
+
+inline void
+gt_pch_nx (int)
+{
+}
+
+inline void
+gt_pch_nx (unsigned int)
+{
+}
+
#endif
projects / gcc.git / blobdiff