1 /* Simple garbage collection for the GNU compiler.
2 Copyright (C) 1999 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
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
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
21 /* Generic garbage collection (GC) functions and data, not specific to
22 any particular GC implementation. */
33 /* Statistics about the allocation. */
34 static ggc_statistics
*ggc_stats
;
36 static void ggc_mark_rtx_ptr
PARAMS ((void *));
37 static void ggc_mark_tree_ptr
PARAMS ((void *));
38 static void ggc_mark_tree_varray_ptr
PARAMS ((void *));
39 static void ggc_mark_tree_hash_table_ptr
PARAMS ((void *));
40 static void ggc_mark_string_ptr
PARAMS ((void *));
41 static boolean ggc_mark_tree_hash_table_entry
PARAMS ((struct hash_entry
*,
44 /* Maintain global roots that are preserved during GC. */
46 /* Global roots that are preserved during calls to gc. */
50 struct ggc_root
*next
;
54 void (*cb
) PROTO ((void *));
57 static struct ggc_root
*roots
;
59 /* Type-correct function to pass to ggc_add_root. It just forwards
60 *ELT (which is an rtx) to ggc_mark_tree_varray. */
63 ggc_mark_rtx_ptr (elt
)
66 ggc_mark_rtx (*(rtx
*) elt
);
69 /* Type-correct function to pass to ggc_add_root. It just forwards
70 *ELT (which is a tree) to ggc_mark_tree. */
73 ggc_mark_tree_ptr (elt
)
76 ggc_mark_tree (*(tree
*) elt
);
79 /* Type-correct function to pass to ggc_add_root. It just forwards
80 ELT (which is really a varray_type *) to ggc_mark_tree_varray. */
83 ggc_mark_tree_varray_ptr (elt
)
86 ggc_mark_tree_varray (*(varray_type
*) elt
);
89 /* Type-correct function to pass to ggc_add_root. It just forwards
90 ELT (which is really a struct hash_table **) to
91 ggc_mark_tree_hash_table. */
94 ggc_mark_tree_hash_table_ptr (elt
)
97 ggc_mark_tree_hash_table (*(struct hash_table
**) elt
);
100 /* Type-correct function to pass to ggc_add_root. It just forwards
101 ELT (which is really a char **) to ggc_mark_string. */
104 ggc_mark_string_ptr (elt
)
107 ggc_mark_string (*(char **) elt
);
110 /* Add BASE as a new garbage collection root. It is an array of
111 length NELT with each element SIZE bytes long. CB is a
112 function that will be called with a pointer to each element
113 of the array; it is the intention that CB call the appropriate
114 routine to mark gc-able memory for that element. */
117 ggc_add_root (base
, nelt
, size
, cb
)
120 void (*cb
) PROTO ((void *));
122 struct ggc_root
*x
= (struct ggc_root
*) xmalloc (sizeof (*x
));
133 /* Register an array of rtx as a GC root. */
136 ggc_add_rtx_root (base
, nelt
)
140 ggc_add_root (base
, nelt
, sizeof(rtx
), ggc_mark_rtx_ptr
);
143 /* Register an array of trees as a GC root. */
146 ggc_add_tree_root (base
, nelt
)
150 ggc_add_root (base
, nelt
, sizeof(tree
), ggc_mark_tree_ptr
);
153 /* Register a varray of trees as a GC root. */
156 ggc_add_tree_varray_root (base
, nelt
)
160 ggc_add_root (base
, nelt
, sizeof (varray_type
),
161 ggc_mark_tree_varray_ptr
);
164 /* Register a hash table of trees as a GC root. */
167 ggc_add_tree_hash_table_root (base
, nelt
)
168 struct hash_table
**base
;
171 ggc_add_root (base
, nelt
, sizeof (struct hash_table
*),
172 ggc_mark_tree_hash_table_ptr
);
175 /* Register an array of strings as a GC root. */
178 ggc_add_string_root (base
, nelt
)
182 ggc_add_root (base
, nelt
, sizeof (char *), ggc_mark_string_ptr
);
185 /* Remove the previously registered GC root at BASE. */
191 struct ggc_root
*x
, **p
;
193 p
= &roots
, x
= roots
;
209 /* Iterate through all registered roots and mark each element. */
216 for (x
= roots
; x
!= NULL
; x
= x
->next
)
219 int s
= x
->size
, n
= x
->nelt
;
220 void (*cb
) PROTO ((void *)) = x
->cb
;
223 for (i
= 0; i
< n
; ++i
, elt
+= s
)
228 /* R had not been previously marked, but has now been marked via
229 ggc_set_mark. Now recurse and process the children. */
232 ggc_mark_rtx_children (r
)
241 enum rtx_code code
= GET_CODE (r
);
242 /* This gets set to a child rtx to eliminate tail recursion. */
245 /* Collect statistics, if appropriate. */
248 ++ggc_stats
->num_rtxs
[(int) code
];
249 ggc_stats
->size_rtxs
[(int) code
] += ggc_get_size (r
);
252 /* ??? If (some of) these are really pass-dependant info, do we
253 have any right poking our noses in? */
257 ggc_mark_rtx (JUMP_LABEL (r
));
260 ggc_mark_rtx (LABEL_REFS (r
));
261 ggc_mark_string (LABEL_ALTERNATE_NAME (r
));
264 ggc_mark_rtx (LABEL_NEXTREF (r
));
265 ggc_mark_rtx (CONTAINING_INSN (r
));
268 ggc_mark_tree (ADDRESSOF_DECL (r
));
271 ggc_mark_rtx (CONST_DOUBLE_CHAIN (r
));
274 switch (NOTE_LINE_NUMBER (r
))
276 case NOTE_INSN_RANGE_START
:
277 case NOTE_INSN_RANGE_END
:
279 ggc_mark_rtx (NOTE_RANGE_INFO (r
));
282 case NOTE_INSN_BLOCK_BEG
:
283 case NOTE_INSN_BLOCK_END
:
284 ggc_mark_tree (NOTE_BLOCK (r
));
288 if (NOTE_LINE_NUMBER (r
) >= 0)
289 ggc_mark_string (NOTE_SOURCE_FILE (r
));
298 for (fmt
= GET_RTX_FORMAT (GET_CODE (r
)), i
= 0; *fmt
; ++fmt
, ++i
)
305 if (ggc_test_and_set_mark (exp
))
307 if (next_rtx
== NULL
)
310 ggc_mark_rtx_children (exp
);
314 ggc_mark_rtvec (XVEC (r
, i
));
317 ggc_mark_if_gcable (XSTR (r
, i
));
322 while ((r
= next_rtx
) != NULL
);
325 /* V had not been previously marked, but has now been marked via
326 ggc_set_mark. Now recurse and process the children. */
329 ggc_mark_rtvec_children (v
)
334 i
= GET_NUM_ELEM (v
);
336 ggc_mark_rtx (RTVEC_ELT (v
, i
));
339 /* T had not been previously marked, but has now been marked via
340 ggc_set_mark. Now recurse and process the children. */
343 ggc_mark_tree_children (t
)
346 enum tree_code code
= TREE_CODE (t
);
348 /* Collect statistics, if appropriate. */
351 ++ggc_stats
->num_trees
[(int) code
];
352 ggc_stats
->size_trees
[(int) code
] += ggc_get_size (t
);
355 /* Bits from common. */
356 ggc_mark_tree (TREE_TYPE (t
));
357 ggc_mark_tree (TREE_CHAIN (t
));
359 /* Some nodes require special handling. */
363 ggc_mark_tree (TREE_PURPOSE (t
));
364 ggc_mark_tree (TREE_VALUE (t
));
369 int i
= TREE_VEC_LENGTH (t
);
371 ggc_mark_tree (TREE_VEC_ELT (t
, i
));
376 ggc_mark_tree (TREE_OPERAND (t
, 0));
377 ggc_mark_tree (SAVE_EXPR_CONTEXT (t
));
378 ggc_mark_rtx (SAVE_EXPR_RTL (t
));
382 ggc_mark_rtx (RTL_EXPR_SEQUENCE (t
));
383 ggc_mark_rtx (RTL_EXPR_RTL (t
));
387 ggc_mark_tree (TREE_OPERAND (t
, 0));
388 ggc_mark_tree (TREE_OPERAND (t
, 1));
389 ggc_mark_rtx (CALL_EXPR_RTL (t
));
393 ggc_mark_tree (TREE_REALPART (t
));
394 ggc_mark_tree (TREE_IMAGPART (t
));
398 ggc_mark_string (TREE_STRING_POINTER (t
));
402 ggc_mark_rtx (DECL_INCOMING_RTL (t
));
405 case IDENTIFIER_NODE
:
406 ggc_mark_string (IDENTIFIER_POINTER (t
));
414 /* But in general we can handle them by class. */
415 switch (TREE_CODE_CLASS (code
))
417 case 'd': /* A decl node. */
418 ggc_mark_string (DECL_SOURCE_FILE (t
));
419 ggc_mark_tree (DECL_SIZE (t
));
420 ggc_mark_tree (DECL_NAME (t
));
421 ggc_mark_tree (DECL_CONTEXT (t
));
422 ggc_mark_tree (DECL_ARGUMENTS (t
));
423 ggc_mark_tree (DECL_RESULT (t
));
424 ggc_mark_tree (DECL_INITIAL (t
));
425 ggc_mark_tree (DECL_ABSTRACT_ORIGIN (t
));
426 ggc_mark_tree (DECL_ASSEMBLER_NAME (t
));
427 ggc_mark_tree (DECL_SECTION_NAME (t
));
428 ggc_mark_tree (DECL_MACHINE_ATTRIBUTES (t
));
429 ggc_mark_rtx (DECL_RTL (t
));
430 ggc_mark_rtx (DECL_LIVE_RANGE_RTL (t
));
431 ggc_mark_tree (DECL_VINDEX (t
));
435 case 't': /* A type node. */
436 ggc_mark_tree (TYPE_SIZE (t
));
437 ggc_mark_tree (TYPE_SIZE_UNIT (t
));
438 ggc_mark_tree (TYPE_ATTRIBUTES (t
));
439 ggc_mark_tree (TYPE_VALUES (t
));
440 ggc_mark_tree (TYPE_POINTER_TO (t
));
441 ggc_mark_tree (TYPE_REFERENCE_TO (t
));
442 ggc_mark_tree (TYPE_NAME (t
));
443 ggc_mark_tree (TYPE_MIN_VALUE (t
));
444 ggc_mark_tree (TYPE_MAX_VALUE (t
));
445 ggc_mark_tree (TYPE_NEXT_VARIANT (t
));
446 ggc_mark_tree (TYPE_MAIN_VARIANT (t
));
447 ggc_mark_tree (TYPE_BINFO (t
));
448 ggc_mark_tree (TYPE_NONCOPIED_PARTS (t
));
449 ggc_mark_tree (TYPE_CONTEXT (t
));
453 case 'b': /* A lexical block. */
454 ggc_mark_tree (BLOCK_VARS (t
));
455 ggc_mark_tree (BLOCK_SUBBLOCKS (t
));
456 ggc_mark_tree (BLOCK_SUPERCONTEXT (t
));
457 ggc_mark_tree (BLOCK_ABSTRACT_ORIGIN (t
));
460 case 'c': /* A constant. */
461 ggc_mark_rtx (TREE_CST_RTL (t
));
464 case 'r': case '<': case '1':
465 case '2': case 'e': case 's': /* Expressions. */
467 int i
= tree_code_length
[TREE_CODE (t
)];
469 ggc_mark_tree (TREE_OPERAND (t
, i
));
479 /* Mark all the elements of the varray V, which contains trees. */
482 ggc_mark_tree_varray (v
)
488 for (i
= v
->num_elements
- 1; i
>= 0; --i
)
489 ggc_mark_tree (VARRAY_TREE (v
, i
));
492 /* Mark the hash table-entry HE. It's key field is really a tree. */
495 ggc_mark_tree_hash_table_entry (he
, k
)
496 struct hash_entry
*he
;
497 hash_table_key k ATTRIBUTE_UNUSED
;
499 ggc_mark_tree ((tree
) he
->key
);
503 /* Mark all the elements of the hash-table H, which contains trees. */
506 ggc_mark_tree_hash_table (ht
)
507 struct hash_table
*ht
;
509 hash_traverse (ht
, ggc_mark_tree_hash_table_entry
, /*info=*/0);
512 /* Allocate a gc-able string. If CONTENTS is null, then the memory will
513 be uninitialized. If LENGTH is -1, then CONTENTS is assumed to be a
514 null-terminated string and the memory sized accordingly. Otherwise,
515 the memory is filled with LENGTH bytes from CONTENTS. */
518 ggc_alloc_string (contents
, length
)
519 const char *contents
;
526 if (contents
== NULL
)
528 length
= strlen (contents
);
531 string
= (char *) ggc_alloc_obj (length
+ 1, 0);
532 if (contents
!= NULL
)
533 memcpy (string
, contents
, length
);
539 /* Print statistics that are independent of the collector in use. */
542 ggc_print_statistics (stream
, stats
)
544 ggc_statistics
*stats
;
548 /* Set the pointer so that during collection we will actually gather
552 /* Then do one collection to fill in the statistics. */
555 /* Total the statistics. */
556 for (code
= 0; code
< MAX_TREE_CODES
; ++code
)
558 stats
->total_num_trees
+= stats
->num_trees
[code
];
559 stats
->total_size_trees
+= stats
->size_trees
[code
];
561 for (code
= 0; code
< NUM_RTX_CODE
; ++code
)
563 stats
->total_num_rtxs
+= stats
->num_rtxs
[code
];
564 stats
->total_size_rtxs
+= stats
->size_rtxs
[code
];
567 /* Print the statistics for trees. */
568 fprintf (stream
, "%-22s%-16s%-16s%-7s\n", "Code",
569 "Number", "Bytes", "% Total");
570 for (code
= 0; code
< MAX_TREE_CODES
; ++code
)
571 if (ggc_stats
->num_trees
[code
])
573 fprintf (stream
, "%s%*s%-15u %-15lu %7.3f\n",
574 tree_code_name
[code
],
575 22 - (int) strlen (tree_code_name
[code
]), "",
576 ggc_stats
->num_trees
[code
],
577 (unsigned long) ggc_stats
->size_trees
[code
],
578 (100 * ((double) ggc_stats
->size_trees
[code
])
579 / ggc_stats
->total_size_trees
));
582 "%-22s%-15u %-15lu\n", "Total",
583 ggc_stats
->total_num_trees
,
584 (unsigned long) ggc_stats
->total_size_trees
);
586 /* Print the statistics for RTL. */
587 fprintf (stream
, "\n%-22s%-16s%-16s%-7s\n", "Code",
588 "Number", "Bytes", "% Total");
589 for (code
= 0; code
< NUM_RTX_CODE
; ++code
)
590 if (ggc_stats
->num_rtxs
[code
])
592 fprintf (stream
, "%s%*s%-15u %-15lu %7.3f\n",
594 22 - (int) strlen (rtx_name
[code
]), "",
595 ggc_stats
->num_rtxs
[code
],
596 (unsigned long) ggc_stats
->size_rtxs
[code
],
597 (100 * ((double) ggc_stats
->size_rtxs
[code
])
598 / ggc_stats
->total_size_rtxs
));
601 "%-22s%-15u %-15lu\n", "Total",
602 ggc_stats
->total_num_rtxs
,
603 (unsigned long) ggc_stats
->total_size_rtxs
);
606 /* Don't gather statistics any more. */