source: arduino-1-6-7/trunk/fuentes/arduino-ide-amd64/hardware/tools/avr/lib/gcc/avr/4.9.2/plugin/include/ggc.h @ 4837

Last change on this file since 4837 was 4837, checked in by daduve, 3 years ago

Adding new version

File size: 9.5 KB
Line 
1/* Garbage collection for the GNU compiler.
2
3   Copyright (C) 1998-2014 Free Software Foundation, Inc.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3.  If not see
19<http://www.gnu.org/licenses/>.  */
20
21#ifndef GCC_GGC_H
22#define GCC_GGC_H
23#include "statistics.h"
24
25/* Symbols are marked with `ggc' for `gcc gc' so as not to interfere with
26   an external gc library that might be linked in.  */
27
28/* Constants for general use.  */
29extern const char empty_string[];       /* empty string */
30
31/* Internal functions and data structures used by the GTY
32   machinery, including the generated gt*.[hc] files.  */
33
34#include "gtype-desc.h"
35
36/* One of these applies its third parameter (with cookie in the fourth
37   parameter) to each pointer in the object pointed to by the first
38   parameter, using the second parameter.  */
39typedef void (*gt_note_pointers) (void *, void *, gt_pointer_operator,
40                                  void *);
41
42/* One of these is called before objects are re-ordered in memory.
43   The first parameter is the original object, the second is the
44   subobject that has had its pointers reordered, the third parameter
45   can compute the new values of a pointer when given the cookie in
46   the fourth parameter.  */
47typedef void (*gt_handle_reorder) (void *, void *, gt_pointer_operator,
48                                   void *);
49
50/* Used by the gt_pch_n_* routines.  Register an object in the hash table.  */
51extern int gt_pch_note_object (void *, void *, gt_note_pointers);
52
53/* Used by the gt_pch_n_* routines.  Register that an object has a reorder
54   function.  */
55extern void gt_pch_note_reorder (void *, void *, gt_handle_reorder);
56
57/* Mark the object in the first parameter and anything it points to.  */
58typedef void (*gt_pointer_walker) (void *);
59
60/* Structures for the easy way to mark roots.
61   In an array, terminated by having base == NULL.  */
62struct ggc_root_tab {
63  void *base;
64  size_t nelt;
65  size_t stride;
66  gt_pointer_walker cb;
67  gt_pointer_walker pchw;
68};
69#define LAST_GGC_ROOT_TAB { NULL, 0, 0, NULL, NULL }
70/* Pointers to arrays of ggc_root_tab, terminated by NULL.  */
71extern const struct ggc_root_tab * const gt_ggc_rtab[];
72extern const struct ggc_root_tab * const gt_ggc_deletable_rtab[];
73extern const struct ggc_root_tab * const gt_pch_cache_rtab[];
74extern const struct ggc_root_tab * const gt_pch_scalar_rtab[];
75
76/* Structure for hash table cache marking.  */
77struct htab;
78struct ggc_cache_tab {
79  struct htab * *base;
80  size_t nelt;
81  size_t stride;
82  gt_pointer_walker cb;
83  gt_pointer_walker pchw;
84  int (*marked_p) (const void *);
85};
86#define LAST_GGC_CACHE_TAB { NULL, 0, 0, NULL, NULL, NULL }
87/* Pointers to arrays of ggc_cache_tab, terminated by NULL.  */
88extern const struct ggc_cache_tab * const gt_ggc_cache_rtab[];
89
90/* If EXPR is not NULL and previously unmarked, mark it and evaluate
91   to true.  Otherwise evaluate to false.  */
92#define ggc_test_and_set_mark(EXPR) \
93  ((EXPR) != NULL && ((void *) (EXPR)) != (void *) 1 && ! ggc_set_mark (EXPR))
94
95#define ggc_mark(EXPR)                          \
96  do {                                          \
97    const void *const a__ = (EXPR);             \
98    if (a__ != NULL && a__ != (void *) 1)       \
99      ggc_set_mark (a__);                       \
100  } while (0)
101
102/* Actually set the mark on a particular region of memory, but don't
103   follow pointers.  This function is called by ggc_mark_*.  It
104   returns zero if the object was not previously marked; nonzero if
105   the object was already marked, or if, for any other reason,
106   pointers in this data structure should not be traversed.  */
107extern int ggc_set_mark (const void *);
108
109/* Return 1 if P has been marked, zero otherwise.
110   P must have been allocated by the GC allocator; it mustn't point to
111   static objects, stack variables, or memory allocated with malloc.  */
112extern int ggc_marked_p (const void *);
113
114/* PCH and GGC handling for strings, mostly trivial.  */
115extern void gt_pch_n_S (const void *);
116extern void gt_ggc_m_S (const void *);
117
118/* End of GTY machinery API.  */
119
120/* Initialize the string pool.  */
121extern void init_stringpool (void);
122
123/* Initialize the garbage collector.  */
124extern void init_ggc (void);
125
126/* When true, identifier nodes are considered as GC roots.  When
127   false, identifier nodes are treated like any other GC-allocated
128   object, and the identifier hash table is treated as a weak
129   hash.  */
130extern bool ggc_protect_identifiers;
131
132/* Write out all GCed objects to F.  */
133extern void gt_pch_save (FILE *f);
134
135
136/* Allocation.  */
137
138/* The internal primitive.  */
139extern void *ggc_internal_alloc_stat (size_t MEM_STAT_DECL)
140  ATTRIBUTE_MALLOC;
141
142extern size_t ggc_round_alloc_size (size_t requested_size);
143
144#define ggc_internal_alloc(s) ggc_internal_alloc_stat (s MEM_STAT_INFO)
145
146/* Allocates cleared memory.  */
147extern void *ggc_internal_cleared_alloc_stat (size_t MEM_STAT_DECL)
148  ATTRIBUTE_MALLOC;
149#define ggc_internal_cleared_alloc(s) ggc_internal_cleared_alloc_stat (s MEM_STAT_INFO)
150
151/* Resize a block.  */
152extern void *ggc_realloc_stat (void *, size_t MEM_STAT_DECL);
153
154/* Free a block.  To be used when known for certain it's not reachable.  */
155extern void ggc_free (void *);
156
157extern void dump_ggc_loc_statistics (bool);
158
159/* Reallocators.  */
160#define GGC_RESIZEVEC(T, P, N) \
161    ((T *) ggc_realloc_stat ((P), (N) * sizeof (T) MEM_STAT_INFO))
162
163#define GGC_RESIZEVAR(T, P, N)                          \
164    ((T *) ggc_realloc_stat ((P), (N) MEM_STAT_INFO))
165
166static inline void *
167ggc_internal_vec_alloc_stat (size_t s, size_t c MEM_STAT_DECL)
168{
169    return ggc_internal_alloc_stat (c * s PASS_MEM_STAT);
170}
171
172static inline void *
173ggc_internal_cleared_vec_alloc_stat (size_t s, size_t c MEM_STAT_DECL)
174{
175    return ggc_internal_cleared_alloc_stat (c * s PASS_MEM_STAT);
176}
177
178#define ggc_internal_cleared_vec_alloc(s, c) \
179    (ggc_internal_cleared_vec_alloc_stat ((s), (c) MEM_STAT_INFO))
180
181static inline void *
182ggc_alloc_atomic_stat (size_t s MEM_STAT_DECL)
183{
184    return ggc_internal_alloc_stat (s PASS_MEM_STAT);
185}
186
187#define ggc_alloc_atomic(S)  (ggc_alloc_atomic_stat ((S) MEM_STAT_INFO))
188
189#define ggc_alloc_cleared_atomic(S)             \
190    (ggc_internal_cleared_alloc_stat ((S) MEM_STAT_INFO))
191
192extern void *ggc_cleared_alloc_htab_ignore_args (size_t, size_t)
193  ATTRIBUTE_MALLOC;
194
195extern void *ggc_cleared_alloc_ptr_array_two_args (size_t, size_t)
196  ATTRIBUTE_MALLOC;
197
198#define htab_create_ggc(SIZE, HASH, EQ, DEL) \
199  htab_create_typed_alloc (SIZE, HASH, EQ, DEL, \
200                           ggc_cleared_alloc_htab_ignore_args,          \
201                           ggc_cleared_alloc_ptr_array_two_args,        \
202                           ggc_free)
203
204#define splay_tree_new_ggc(COMPARE, ALLOC_TREE, ALLOC_NODE)                  \
205  splay_tree_new_typed_alloc (COMPARE, NULL, NULL, &ALLOC_TREE, &ALLOC_NODE, \
206                              &ggc_splay_dont_free, NULL)
207
208extern void *ggc_splay_alloc (int, void *)
209  ATTRIBUTE_MALLOC;
210
211extern void ggc_splay_dont_free (void *, void *);
212
213/* Allocate a gc-able string, and fill it with LENGTH bytes from CONTENTS.
214   If LENGTH is -1, then CONTENTS is assumed to be a
215   null-terminated string and the memory sized accordingly.  */
216extern const char *ggc_alloc_string_stat (const char *contents, int length
217                                          MEM_STAT_DECL);
218
219#define ggc_alloc_string(c, l) ggc_alloc_string_stat (c, l MEM_STAT_INFO)
220
221/* Make a copy of S, in GC-able memory.  */
222#define ggc_strdup(S) ggc_alloc_string_stat ((S), -1 MEM_STAT_INFO)
223
224/* Invoke the collector.  Garbage collection occurs only when this
225   function is called, not during allocations.  */
226extern void ggc_collect (void);
227
228/* Register an additional root table.  This can be useful for some
229   plugins.  Does nothing if the passed pointer is NULL. */
230extern void ggc_register_root_tab (const struct ggc_root_tab *);
231
232/* Register an additional cache table.  This can be useful for some
233   plugins.  Does nothing if the passed pointer is NULL. */
234extern void ggc_register_cache_tab (const struct ggc_cache_tab *);
235
236/* Read objects previously saved with gt_pch_save from F.  */
237extern void gt_pch_restore (FILE *f);
238
239/* Statistics.  */
240
241/* Print allocation statistics.  */
242extern void ggc_print_statistics (void);
243
244extern void stringpool_statistics (void);
245
246/* Heuristics.  */
247extern void init_ggc_heuristics (void);
248
249#define ggc_alloc_rtvec_sized(NELT)                             \
250  ggc_alloc_rtvec_def (sizeof (struct rtvec_def)                \
251                       + ((NELT) - 1) * sizeof (rtx))           \
252
253/* Memory statistics passing versions of some allocators.  Too few of them to
254   make gengtype produce them, so just define the needed ones here.  */
255static inline struct rtx_def *
256ggc_alloc_rtx_def_stat (size_t s MEM_STAT_DECL)
257{
258  return (struct rtx_def *) ggc_internal_alloc_stat (s PASS_MEM_STAT);
259}
260
261static inline union tree_node *
262ggc_alloc_tree_node_stat (size_t s MEM_STAT_DECL)
263{
264  return (union tree_node *) ggc_internal_alloc_stat (s PASS_MEM_STAT);
265}
266
267static inline union tree_node *
268ggc_alloc_cleared_tree_node_stat (size_t s MEM_STAT_DECL)
269{
270  return (union tree_node *) ggc_internal_cleared_alloc_stat (s PASS_MEM_STAT);
271}
272
273static inline struct gimple_statement_base *
274ggc_alloc_cleared_gimple_statement_stat (size_t s MEM_STAT_DECL)
275{
276  return (struct gimple_statement_base *)
277    ggc_internal_cleared_alloc_stat (s PASS_MEM_STAT);
278}
279
280static inline struct simd_clone *
281ggc_alloc_cleared_simd_clone_stat (size_t s MEM_STAT_DECL)
282{
283  return (struct simd_clone *)
284    ggc_internal_cleared_alloc_stat (s PASS_MEM_STAT);
285}
286
287#endif
Note: See TracBrowser for help on using the repository browser.