Remove s390x __LONG_MAX__ special case from glimits.h;
[official-gcc.git] / gcc / ggc.h
blob2d214a90e858f511f12c783776422cff53dd3997
1 /* Garbage collection for the GNU compiler.
2 Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GNU CC.
6 GNU CC is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
11 GNU CC is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
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 the Free
18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
19 02111-1307, USA. */
21 #include "varray.h"
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. */
26 /* These structures are defined in various headers throughout the
27 compiler. However, rather than force everyone who includes this
28 header to include all the headers in which they are declared, we
29 just forward-declare them here. */
30 struct eh_status;
31 struct emit_status;
32 struct expr_status;
33 struct hash_table;
34 struct label_node;
35 struct rtx_def;
36 struct rtvec_def;
37 struct stmt_status;
38 union tree_node;
39 struct varasm_status;
41 /* Constants for general use. */
42 extern const char empty_string[]; /* empty string */
43 extern const char digit_vector[]; /* "0" .. "9" */
44 #define digit_string(d) (digit_vector + ((d) * 2))
46 /* Trees that have been marked, but whose children still need marking. */
47 extern varray_type ggc_pending_trees;
49 /* Manipulate global roots that are needed between calls to gc. */
50 void ggc_add_root PARAMS ((void *base, int nelt, int size, void (*)(void *)));
51 void ggc_add_rtx_root PARAMS ((struct rtx_def **, int nelt));
52 void ggc_add_tree_root PARAMS ((union tree_node **, int nelt));
53 void ggc_add_rtx_varray_root PARAMS ((struct varray_head_tag **, int nelt));
54 void ggc_add_tree_varray_root PARAMS ((struct varray_head_tag **, int nelt));
55 void ggc_add_tree_hash_table_root PARAMS ((struct hash_table **, int nelt));
56 void ggc_del_root PARAMS ((void *base));
58 /* Mark nodes from the gc_add_root callback. These functions follow
59 pointers to mark other objects too. */
60 extern void ggc_mark_rtx_varray PARAMS ((struct varray_head_tag *));
61 extern void ggc_mark_tree_varray PARAMS ((struct varray_head_tag *));
62 extern void ggc_mark_tree_hash_table PARAMS ((struct hash_table *));
63 extern void ggc_mark_roots PARAMS ((void));
65 extern void ggc_mark_rtx_children PARAMS ((struct rtx_def *));
66 extern void ggc_mark_rtvec_children PARAMS ((struct rtvec_def *));
68 /* If EXPR is not NULL and previously unmarked, mark it and evaluate
69 to true. Otherwise evaluate to false. */
70 #define ggc_test_and_set_mark(EXPR) \
71 ((EXPR) != NULL && ! ggc_set_mark (EXPR))
73 #define ggc_mark_rtx(EXPR) \
74 do { \
75 rtx r__ = (EXPR); \
76 if (ggc_test_and_set_mark (r__)) \
77 ggc_mark_rtx_children (r__); \
78 } while (0)
80 #define ggc_mark_tree(EXPR) \
81 do { \
82 tree t__ = (EXPR); \
83 if (ggc_test_and_set_mark (t__)) \
84 VARRAY_PUSH_TREE (ggc_pending_trees, t__); \
85 } while (0)
87 #define ggc_mark_nonnull_tree(EXPR) \
88 do { \
89 tree t__ = (EXPR); \
90 if (! ggc_set_mark (t__)) \
91 VARRAY_PUSH_TREE (ggc_pending_trees, t__); \
92 } while (0)
94 #define ggc_mark_rtvec(EXPR) \
95 do { \
96 rtvec v__ = (EXPR); \
97 if (ggc_test_and_set_mark (v__)) \
98 ggc_mark_rtvec_children (v__); \
99 } while (0)
101 #define ggc_mark(EXPR) \
102 do { \
103 const void *a__ = (EXPR); \
104 if (a__ != NULL) \
105 ggc_set_mark (a__); \
106 } while (0)
108 /* A GC implementation must provide these functions. */
110 /* Initialize the garbage collector. */
111 extern void init_ggc PARAMS ((void));
112 extern void init_stringpool PARAMS ((void));
114 /* Start a new GGC context. Memory allocated in previous contexts
115 will not be collected while the new context is active. */
116 extern void ggc_push_context PARAMS ((void));
118 /* Finish a GC context. Any uncollected memory in the new context
119 will be merged with the old context. */
120 extern void ggc_pop_context PARAMS ((void));
122 /* Allocation. */
124 /* The internal primitive. */
125 void *ggc_alloc PARAMS ((size_t));
126 /* Like ggc_alloc, but allocates cleared memory. */
127 void *ggc_alloc_cleared PARAMS ((size_t));
129 #define ggc_alloc_rtx(NSLOTS) \
130 ((struct rtx_def *) ggc_alloc (sizeof (struct rtx_def) \
131 + ((NSLOTS) - 1) * sizeof (rtunion)))
133 #define ggc_alloc_rtvec(NELT) \
134 ((struct rtvec_def *) ggc_alloc (sizeof (struct rtvec_def) \
135 + ((NELT) - 1) * sizeof (rtx)))
137 #define ggc_alloc_tree(LENGTH) ((union tree_node *) ggc_alloc (LENGTH))
139 /* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS.
140 If LENGTH is -1, then CONTENTS is assumed to be a
141 null-terminated string and the memory sized accordingly. */
142 const char *ggc_alloc_string PARAMS ((const char *contents, int length));
144 /* Make a copy of S, in GC-able memory. */
145 #define ggc_strdup(S) ggc_alloc_string((S), -1)
147 /* Invoke the collector. Garbage collection occurs only when this
148 function is called, not during allocations. */
149 void ggc_collect PARAMS ((void));
151 /* Actually set the mark on a particular region of memory, but don't
152 follow pointers. This function is called by ggc_mark_*. It
153 returns zero if the object was not previously marked; non-zero if
154 the object was already marked, or if, for any other reason,
155 pointers in this data structure should not be traversed. */
156 int ggc_set_mark PARAMS ((const void *));
158 /* Callbacks to the languages. */
160 /* This is the language's opportunity to mark nodes held through
161 the lang_specific hooks in the tree. */
162 void lang_mark_tree PARAMS ((union tree_node *));
164 /* The FALSE_LABEL_STACK, declared in except.h, has language-dependent
165 semantics. If a front-end needs to mark the false label stack, it
166 should set this pointer to a non-NULL value. Otherwise, no marking
167 will be done. */
168 extern void (*lang_mark_false_label_stack) PARAMS ((struct label_node *));
170 /* Mark functions for various structs scattered about. */
172 void mark_eh_status PARAMS ((struct eh_status *));
173 void mark_emit_status PARAMS ((struct emit_status *));
174 void mark_expr_status PARAMS ((struct expr_status *));
175 void mark_stmt_status PARAMS ((struct stmt_status *));
176 void mark_varasm_status PARAMS ((struct varasm_status *));
177 void mark_optab PARAMS ((void *));
179 /* Statistics. */
181 /* This structure contains the statistics common to all collectors.
182 Particular collectors can extend this structure. */
183 typedef struct ggc_statistics
185 /* The Ith element is the number of nodes allocated with code I. */
186 unsigned num_trees[256];
187 /* The Ith element is the number of bytes allocated by nodes with
188 code I. */
189 size_t size_trees[256];
190 /* The Ith element is the number of nodes allocated with code I. */
191 unsigned num_rtxs[256];
192 /* The Ith element is the number of bytes allocated by nodes with
193 code I. */
194 size_t size_rtxs[256];
195 /* The total size of the tree nodes allocated. */
196 size_t total_size_trees;
197 /* The total size of the RTL nodes allocated. */
198 size_t total_size_rtxs;
199 /* The total number of tree nodes allocated. */
200 unsigned total_num_trees;
201 /* The total number of RTL nodes allocated. */
202 unsigned total_num_rtxs;
203 } ggc_statistics;
205 /* Return the number of bytes allocated at the indicated address. */
206 size_t ggc_get_size PARAMS ((const void *));
208 /* Used by the various collectors to gather and print statistics that
209 do not depend on the collector in use. */
210 void ggc_print_common_statistics PARAMS ((FILE *, ggc_statistics *));
212 /* Print allocation statistics. */
213 extern void ggc_print_statistics PARAMS ((void));
214 void stringpool_statistics PARAMS ((void));