2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1995 by Xerox Corporation. All rights reserved.
4 * Copyright (c) 1997 by Silicon Graphics. All rights reserved.
5 * Copyright (c) 1999-2000 by Hewlett-Packard Company. All rights reserved.
7 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
8 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
10 * Permission is hereby granted to use or copy this program
11 * for any purpose, provided the above notices are retained on all copies.
12 * Permission to modify the code and to distribute modified code is granted,
13 * provided the above notices are retained, and a notice that the code was
14 * modified is included with the above copyright notice.
17 #include "private/dbg_mlc.h"
19 void GC_default_print_heap_obj_proc();
20 GC_API void GC_register_finalizer_no_order
21 GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
22 GC_finalization_proc *ofn, GC_PTR *ocd));
25 #ifndef SHORT_DBG_HDRS
26 /* Check whether object with base pointer p has debugging info */
27 /* p is assumed to point to a legitimate object in our part */
29 /* This excludes the check as to whether the back pointer is */
30 /* odd, which is added by the GC_HAS_DEBUG_INFO macro. */
31 /* Note that if DBG_HDRS_ALL is set, uncollectable objects */
32 /* on free lists may not have debug information set. Thus it's */
33 /* not always safe to return TRUE, even if the client does */
35 GC_bool GC_has_other_debug_info(p)
38 register oh * ohdr = (oh *)p;
39 register ptr_t body = (ptr_t)(ohdr + 1);
40 register word sz = GC_size((ptr_t) ohdr);
42 if (HBLKPTR((ptr_t)ohdr) != HBLKPTR((ptr_t)body)
43 || sz < DEBUG_BYTES + EXTRA_BYTES) {
46 if (ohdr -> oh_sz == sz) {
47 /* Object may have had debug info, but has been deallocated */
50 if (ohdr -> oh_sf == (START_FLAG ^ (word)body)) return(TRUE);
51 if (((word *)ohdr)[BYTES_TO_WORDS(sz)-1] == (END_FLAG ^ (word)body)) {
62 # if defined(LINUX) || defined(SUNOS4) || defined(SUNOS5) \
63 || defined(HPUX) || defined(IRIX5) || defined(OSF1)
64 # define RANDOM() random()
66 # define RANDOM() (long)rand()
69 /* Store back pointer to source in dest, if that appears to be possible. */
70 /* This is not completely safe, since we may mistakenly conclude that */
71 /* dest has a debugging wrapper. But the error probability is very */
72 /* small, and this shouldn't be used in production code. */
73 /* We assume that dest is the real base pointer. Source will usually */
74 /* be a pointer to the interior of an object. */
75 void GC_store_back_pointer(ptr_t source, ptr_t dest)
77 if (GC_HAS_DEBUG_INFO(dest)) {
78 ((oh *)dest) -> oh_back_ptr = HIDE_BACK_PTR(source);
82 void GC_marked_for_finalization(ptr_t dest) {
83 GC_store_back_pointer(MARKED_FOR_FINALIZATION, dest);
86 /* Store information about the object referencing dest in *base_p */
88 /* source is root ==> *base_p = address, *offset_p = 0 */
89 /* source is heap object ==> *base_p != 0, *offset_p = offset */
90 /* Returns 1 on success, 0 if source couldn't be determined. */
91 /* Dest can be any address within a heap object. */
92 GC_ref_kind GC_get_back_ptr_info(void *dest, void **base_p, size_t *offset_p)
94 oh * hdr = (oh *)GC_base(dest);
97 if (!GC_HAS_DEBUG_INFO((ptr_t) hdr)) return GC_NO_SPACE;
98 bp = REVEAL_POINTER(hdr -> oh_back_ptr);
99 if (MARKED_FOR_FINALIZATION == bp) return GC_FINALIZER_REFD;
100 if (MARKED_FROM_REGISTER == bp) return GC_REFD_FROM_REG;
101 if (NOT_MARKED == bp) return GC_UNREFERENCED;
103 /* Heuristically try to fix off by 1 errors we introduced by */
104 /* insisting on even addresses. */
106 ptr_t alternate_ptr = bp + 1;
107 ptr_t target = *(ptr_t *)bp;
108 ptr_t alternate_target = *(ptr_t *)alternate_ptr;
110 if (alternate_target >= GC_least_plausible_heap_addr
111 && alternate_target <= GC_greatest_plausible_heap_addr
112 && (target < GC_least_plausible_heap_addr
113 || target > GC_greatest_plausible_heap_addr)) {
118 bp_base = GC_base(bp);
122 return GC_REFD_FROM_ROOT;
124 if (GC_HAS_DEBUG_INFO(bp_base)) bp_base += sizeof(oh);
126 *offset_p = bp - bp_base;
127 return GC_REFD_FROM_HEAP;
131 /* Generate a random heap address. */
132 /* The resulting address is in the heap, but */
133 /* not necessarily inside a valid object. */
134 void *GC_generate_random_heap_address(void)
137 long heap_offset = RANDOM();
138 if (GC_heapsize > RAND_MAX) {
139 heap_offset *= RAND_MAX;
140 heap_offset += RANDOM();
142 heap_offset %= GC_heapsize;
143 /* This doesn't yield a uniform distribution, especially if */
144 /* e.g. RAND_MAX = 1.5* GC_heapsize. But for typical cases, */
145 /* it's not too bad. */
146 for (i = 0; i < GC_n_heap_sects; ++ i) {
147 int size = GC_heap_sects[i].hs_bytes;
148 if (heap_offset < size) {
149 return GC_heap_sects[i].hs_start + heap_offset;
154 ABORT("GC_generate_random_heap_address: size inconsistency");
159 /* Generate a random address inside a valid marked heap object. */
160 void *GC_generate_random_valid_address(void)
165 result = GC_generate_random_heap_address();
166 base = GC_base(result);
167 if (0 == base) continue;
168 if (!GC_is_marked(base)) continue;
173 /* Print back trace for p */
174 void GC_print_backtrace(void *p)
182 GC_print_heap_obj(GC_base(current));
183 GC_err_printf0("\n");
185 source = GC_get_back_ptr_info(current, &base, &offset);
186 if (GC_UNREFERENCED == source) {
187 GC_err_printf0("Reference could not be found\n");
190 if (GC_NO_SPACE == source) {
191 GC_err_printf0("No debug info in object: Can't find reference\n");
194 GC_err_printf1("Reachable via %d levels of pointers from ",
197 case GC_REFD_FROM_ROOT:
198 GC_err_printf1("root at 0x%lx\n", (unsigned long)base);
200 case GC_REFD_FROM_REG:
201 GC_err_printf0("root in register\n");
203 case GC_FINALIZER_REFD:
204 GC_err_printf0("list of finalizable objects\n");
206 case GC_REFD_FROM_HEAP:
207 GC_err_printf1("offset %ld in object:\n", (unsigned long)offset);
208 /* Take GC_base(base) to get real base, i.e. header. */
209 GC_print_heap_obj(GC_base(base));
210 GC_err_printf0("\n");
218 /* Force a garbage collection and generate a backtrace from a */
219 /* random heap address. */
220 void GC_generate_random_backtrace(void)
224 current = GC_generate_random_valid_address();
225 GC_printf1("Chose address 0x%lx in object\n", (unsigned long)current);
226 GC_print_backtrace(current);
229 #endif /* KEEP_BACK_PTRS */
231 # define CROSSES_HBLK(p, sz) \
232 (((word)(p + sizeof(oh) + sz - 1) ^ (word)p) >= HBLKSIZE)
233 /* Store debugging info into p. Return displaced pointer. */
234 /* Assumes we don't hold allocation lock. */
235 ptr_t GC_store_debug_info(p, sz, string, integer)
236 register ptr_t p; /* base pointer */
238 GC_CONST char * string;
241 register word * result = (word *)((oh *)p + 1);
244 /* There is some argument that we should dissble signals here. */
245 /* But that's expensive. And this way things should only appear */
246 /* inconsistent while we're in the handler. */
248 GC_ASSERT(GC_size(p) >= sizeof(oh) + sz);
249 GC_ASSERT(!(SMALL_OBJ(sz) && CROSSES_HBLK(p, sz)));
250 # ifdef KEEP_BACK_PTRS
251 ((oh *)p) -> oh_back_ptr = HIDE_BACK_PTR(NOT_MARKED);
253 # ifdef MAKE_BACK_GRAPH
254 ((oh *)p) -> oh_bg_ptr = HIDE_BACK_PTR((ptr_t)0);
256 ((oh *)p) -> oh_string = string;
257 ((oh *)p) -> oh_int = integer;
258 # ifndef SHORT_DBG_HDRS
259 ((oh *)p) -> oh_sz = sz;
260 ((oh *)p) -> oh_sf = START_FLAG ^ (word)result;
261 ((word *)p)[BYTES_TO_WORDS(GC_size(p))-1] =
262 result[SIMPLE_ROUNDED_UP_WORDS(sz)] = END_FLAG ^ (word)result;
265 return((ptr_t)result);
269 /* Store debugging info into p. Return displaced pointer. */
270 /* This version assumes we do hold the allocation lock. */
271 ptr_t GC_store_debug_info_inner(p, sz, string, integer)
272 register ptr_t p; /* base pointer */
277 register word * result = (word *)((oh *)p + 1);
279 /* There is some argument that we should disable signals here. */
280 /* But that's expensive. And this way things should only appear */
281 /* inconsistent while we're in the handler. */
282 GC_ASSERT(GC_size(p) >= sizeof(oh) + sz);
283 GC_ASSERT(!(SMALL_OBJ(sz) && CROSSES_HBLK(p, sz)));
284 # ifdef KEEP_BACK_PTRS
285 ((oh *)p) -> oh_back_ptr = HIDE_BACK_PTR(NOT_MARKED);
287 # ifdef MAKE_BACK_GRAPH
288 ((oh *)p) -> oh_bg_ptr = HIDE_BACK_PTR((ptr_t)0);
290 ((oh *)p) -> oh_string = string;
291 ((oh *)p) -> oh_int = integer;
292 # ifndef SHORT_DBG_HDRS
293 ((oh *)p) -> oh_sz = sz;
294 ((oh *)p) -> oh_sf = START_FLAG ^ (word)result;
295 ((word *)p)[BYTES_TO_WORDS(GC_size(p))-1] =
296 result[SIMPLE_ROUNDED_UP_WORDS(sz)] = END_FLAG ^ (word)result;
298 return((ptr_t)result);
302 #ifndef SHORT_DBG_HDRS
303 /* Check the object with debugging info at ohdr */
304 /* return NIL if it's OK. Else return clobbered */
306 ptr_t GC_check_annotated_obj(ohdr)
309 register ptr_t body = (ptr_t)(ohdr + 1);
310 register word gc_sz = GC_size((ptr_t)ohdr);
311 if (ohdr -> oh_sz + DEBUG_BYTES > gc_sz) {
312 return((ptr_t)(&(ohdr -> oh_sz)));
314 if (ohdr -> oh_sf != (START_FLAG ^ (word)body)) {
315 return((ptr_t)(&(ohdr -> oh_sf)));
317 if (((word *)ohdr)[BYTES_TO_WORDS(gc_sz)-1] != (END_FLAG ^ (word)body)) {
318 return((ptr_t)((word *)ohdr + BYTES_TO_WORDS(gc_sz)-1));
320 if (((word *)body)[SIMPLE_ROUNDED_UP_WORDS(ohdr -> oh_sz)]
321 != (END_FLAG ^ (word)body)) {
322 return((ptr_t)((word *)body + SIMPLE_ROUNDED_UP_WORDS(ohdr -> oh_sz)));
326 #endif /* !SHORT_DBG_HDRS */
331 register oh * ohdr = (oh *)GC_base(p);
333 GC_ASSERT(!I_HOLD_LOCK());
334 GC_err_printf1("0x%lx (", ((unsigned long)ohdr + sizeof(oh)));
335 GC_err_puts(ohdr -> oh_string);
336 # ifdef SHORT_DBG_HDRS
337 GC_err_printf1(":%ld)\n", (unsigned long)(ohdr -> oh_int));
339 GC_err_printf2(":%ld, sz=%ld)\n", (unsigned long)(ohdr -> oh_int),
340 (unsigned long)(ohdr -> oh_sz));
342 PRINT_CALL_CHAIN(ohdr);
345 # if defined(__STDC__) || defined(__cplusplus)
346 void GC_debug_print_heap_obj_proc(ptr_t p)
348 void GC_debug_print_heap_obj_proc(p)
352 GC_ASSERT(!I_HOLD_LOCK());
353 if (GC_HAS_DEBUG_INFO(p)) {
356 GC_default_print_heap_obj_proc(p);
360 #ifndef SHORT_DBG_HDRS
361 void GC_print_smashed_obj(p, clobbered_addr)
362 ptr_t p, clobbered_addr;
364 register oh * ohdr = (oh *)GC_base(p);
366 GC_ASSERT(!I_HOLD_LOCK());
367 GC_err_printf2("0x%lx in object at 0x%lx(", (unsigned long)clobbered_addr,
369 if (clobbered_addr <= (ptr_t)(&(ohdr -> oh_sz))
370 || ohdr -> oh_string == 0) {
371 GC_err_printf1("<smashed>, appr. sz = %ld)\n",
372 (GC_size((ptr_t)ohdr) - DEBUG_BYTES));
374 if (ohdr -> oh_string[0] == '\0') {
375 GC_err_puts("EMPTY(smashed?)");
377 GC_err_puts(ohdr -> oh_string);
379 GC_err_printf2(":%ld, sz=%ld)\n", (unsigned long)(ohdr -> oh_int),
380 (unsigned long)(ohdr -> oh_sz));
381 PRINT_CALL_CHAIN(ohdr);
386 void GC_check_heap_proc GC_PROTO((void));
388 void GC_print_all_smashed_proc GC_PROTO((void));
390 void GC_do_nothing() {}
392 void GC_start_debugging()
394 # ifndef SHORT_DBG_HDRS
395 GC_check_heap = GC_check_heap_proc;
396 GC_print_all_smashed = GC_print_all_smashed_proc;
398 GC_check_heap = GC_do_nothing;
399 GC_print_all_smashed = GC_do_nothing;
401 GC_print_heap_obj = GC_debug_print_heap_obj_proc;
402 GC_debugging_started = TRUE;
403 GC_register_displacement((word)sizeof(oh));
406 # if defined(__STDC__) || defined(__cplusplus)
407 void GC_debug_register_displacement(GC_word offset)
409 void GC_debug_register_displacement(offset)
413 GC_register_displacement(offset);
414 GC_register_displacement((word)sizeof(oh) + offset);
418 GC_PTR GC_debug_malloc(size_t lb, GC_EXTRA_PARAMS)
420 GC_PTR GC_debug_malloc(lb, s, i)
424 # ifdef GC_ADD_CALLER
425 --> GC_ADD_CALLER not implemented for K&R C
429 GC_PTR result = GC_malloc(lb + DEBUG_BYTES);
432 GC_err_printf1("GC_debug_malloc(%ld) returning NIL (",
435 GC_err_printf1(":%ld)\n", (unsigned long)i);
438 if (!GC_debugging_started) {
439 GC_start_debugging();
441 ADD_CALL_CHAIN(result, ra);
442 return (GC_store_debug_info(result, (word)lb, s, (word)i));
446 GC_PTR GC_debug_malloc_ignore_off_page(size_t lb, GC_EXTRA_PARAMS)
448 GC_PTR GC_debug_malloc_ignore_off_page(lb, s, i)
452 # ifdef GC_ADD_CALLER
453 --> GC_ADD_CALLER not implemented for K&R C
457 GC_PTR result = GC_malloc_ignore_off_page(lb + DEBUG_BYTES);
460 GC_err_printf1("GC_debug_malloc_ignore_off_page(%ld) returning NIL (",
463 GC_err_printf1(":%ld)\n", (unsigned long)i);
466 if (!GC_debugging_started) {
467 GC_start_debugging();
469 ADD_CALL_CHAIN(result, ra);
470 return (GC_store_debug_info(result, (word)lb, s, (word)i));
474 GC_PTR GC_debug_malloc_atomic_ignore_off_page(size_t lb, GC_EXTRA_PARAMS)
476 GC_PTR GC_debug_malloc_atomic_ignore_off_page(lb, s, i)
480 # ifdef GC_ADD_CALLER
481 --> GC_ADD_CALLER not implemented for K&R C
485 GC_PTR result = GC_malloc_atomic_ignore_off_page(lb + DEBUG_BYTES);
488 GC_err_printf1("GC_debug_malloc_atomic_ignore_off_page(%ld)"
489 " returning NIL (", (unsigned long) lb);
491 GC_err_printf1(":%ld)\n", (unsigned long)i);
494 if (!GC_debugging_started) {
495 GC_start_debugging();
497 ADD_CALL_CHAIN(result, ra);
498 return (GC_store_debug_info(result, (word)lb, s, (word)i));
503 * An allocation function for internal use.
504 * Normally internally allocated objects do not have debug information.
505 * But in this case, we need to make sure that all objects have debug
507 * We assume debugging was started in collector initialization,
508 * and we already hold the GC lock.
510 GC_PTR GC_debug_generic_malloc_inner(size_t lb, int k)
512 GC_PTR result = GC_generic_malloc_inner(lb + DEBUG_BYTES, k);
515 GC_err_printf1("GC internal allocation (%ld bytes) returning NIL\n",
519 ADD_CALL_CHAIN(result, GC_RETURN_ADDR);
520 return (GC_store_debug_info_inner(result, (word)lb, "INTERNAL", (word)0));
523 GC_PTR GC_debug_generic_malloc_inner_ignore_off_page(size_t lb, int k)
525 GC_PTR result = GC_generic_malloc_inner_ignore_off_page(
526 lb + DEBUG_BYTES, k);
529 GC_err_printf1("GC internal allocation (%ld bytes) returning NIL\n",
533 ADD_CALL_CHAIN(result, GC_RETURN_ADDR);
534 return (GC_store_debug_info_inner(result, (word)lb, "INTERNAL", (word)0));
538 #ifdef STUBBORN_ALLOC
540 GC_PTR GC_debug_malloc_stubborn(size_t lb, GC_EXTRA_PARAMS)
542 GC_PTR GC_debug_malloc_stubborn(lb, s, i)
548 GC_PTR result = GC_malloc_stubborn(lb + DEBUG_BYTES);
551 GC_err_printf1("GC_debug_malloc(%ld) returning NIL (",
554 GC_err_printf1(":%ld)\n", (unsigned long)i);
557 if (!GC_debugging_started) {
558 GC_start_debugging();
560 ADD_CALL_CHAIN(result, ra);
561 return (GC_store_debug_info(result, (word)lb, s, (word)i));
564 void GC_debug_change_stubborn(p)
567 register GC_PTR q = GC_base(p);
571 GC_err_printf1("Bad argument: 0x%lx to GC_debug_change_stubborn\n",
573 ABORT("GC_debug_change_stubborn: bad arg");
576 if (hhdr -> hb_obj_kind != STUBBORN) {
577 GC_err_printf1("GC_debug_change_stubborn arg not stubborn: 0x%lx\n",
579 ABORT("GC_debug_change_stubborn: arg not stubborn");
581 GC_change_stubborn(q);
584 void GC_debug_end_stubborn_change(p)
587 register GC_PTR q = GC_base(p);
591 GC_err_printf1("Bad argument: 0x%lx to GC_debug_end_stubborn_change\n",
593 ABORT("GC_debug_end_stubborn_change: bad arg");
596 if (hhdr -> hb_obj_kind != STUBBORN) {
597 GC_err_printf1("debug_end_stubborn_change arg not stubborn: 0x%lx\n",
599 ABORT("GC_debug_end_stubborn_change: arg not stubborn");
601 GC_end_stubborn_change(q);
604 #else /* !STUBBORN_ALLOC */
607 GC_PTR GC_debug_malloc_stubborn(size_t lb, GC_EXTRA_PARAMS)
609 GC_PTR GC_debug_malloc_stubborn(lb, s, i)
615 return GC_debug_malloc(lb, OPT_RA s, i);
618 void GC_debug_change_stubborn(p)
623 void GC_debug_end_stubborn_change(p)
628 #endif /* !STUBBORN_ALLOC */
631 GC_PTR GC_debug_malloc_atomic(size_t lb, GC_EXTRA_PARAMS)
633 GC_PTR GC_debug_malloc_atomic(lb, s, i)
639 GC_PTR result = GC_malloc_atomic(lb + DEBUG_BYTES);
642 GC_err_printf1("GC_debug_malloc_atomic(%ld) returning NIL (",
645 GC_err_printf1(":%ld)\n", (unsigned long)i);
648 if (!GC_debugging_started) {
649 GC_start_debugging();
651 ADD_CALL_CHAIN(result, ra);
652 return (GC_store_debug_info(result, (word)lb, s, (word)i));
656 GC_PTR GC_debug_malloc_uncollectable(size_t lb, GC_EXTRA_PARAMS)
658 GC_PTR GC_debug_malloc_uncollectable(lb, s, i)
664 GC_PTR result = GC_malloc_uncollectable(lb + UNCOLLECTABLE_DEBUG_BYTES);
667 GC_err_printf1("GC_debug_malloc_uncollectable(%ld) returning NIL (",
670 GC_err_printf1(":%ld)\n", (unsigned long)i);
673 if (!GC_debugging_started) {
674 GC_start_debugging();
676 ADD_CALL_CHAIN(result, ra);
677 return (GC_store_debug_info(result, (word)lb, s, (word)i));
680 #ifdef ATOMIC_UNCOLLECTABLE
682 GC_PTR GC_debug_malloc_atomic_uncollectable(size_t lb, GC_EXTRA_PARAMS)
684 GC_PTR GC_debug_malloc_atomic_uncollectable(lb, s, i)
691 GC_malloc_atomic_uncollectable(lb + UNCOLLECTABLE_DEBUG_BYTES);
695 "GC_debug_malloc_atomic_uncollectable(%ld) returning NIL (",
698 GC_err_printf1(":%ld)\n", (unsigned long)i);
701 if (!GC_debugging_started) {
702 GC_start_debugging();
704 ADD_CALL_CHAIN(result, ra);
705 return (GC_store_debug_info(result, (word)lb, s, (word)i));
707 #endif /* ATOMIC_UNCOLLECTABLE */
710 void GC_debug_free(GC_PTR p)
712 void GC_debug_free(p)
716 register GC_PTR base;
717 register ptr_t clobbered;
722 GC_err_printf1("Attempt to free invalid pointer %lx\n",
724 ABORT("free(invalid pointer)");
726 if ((ptr_t)p - (ptr_t)base != sizeof(oh)) {
728 "GC_debug_free called on pointer %lx wo debugging info\n",
731 # ifndef SHORT_DBG_HDRS
732 clobbered = GC_check_annotated_obj((oh *)base);
733 if (clobbered != 0) {
734 if (((oh *)base) -> oh_sz == GC_size(base)) {
736 "GC_debug_free: found previously deallocated (?) object at ");
738 GC_err_printf0("GC_debug_free: found smashed location at ");
740 GC_print_smashed_obj(p, clobbered);
742 /* Invalidate size */
743 ((oh *)base) -> oh_sz = GC_size(base);
744 # endif /* SHORT_DBG_HDRS */
749 register hdr * hhdr = HDR(p);
750 GC_bool uncollectable = FALSE;
752 if (hhdr -> hb_obj_kind == UNCOLLECTABLE) {
753 uncollectable = TRUE;
755 # ifdef ATOMIC_UNCOLLECTABLE
756 if (hhdr -> hb_obj_kind == AUNCOLLECTABLE) {
757 uncollectable = TRUE;
760 if (uncollectable) GC_free(base);
761 } /* !GC_find_leak */
766 extern void GC_free_inner(GC_PTR p);
768 /* Used internally; we assume it's called correctly. */
769 void GC_debug_free_inner(GC_PTR p)
771 GC_free_inner(GC_base(p));
776 GC_PTR GC_debug_realloc(GC_PTR p, size_t lb, GC_EXTRA_PARAMS)
778 GC_PTR GC_debug_realloc(p, lb, s, i)
785 register GC_PTR base = GC_base(p);
786 register ptr_t clobbered;
787 register GC_PTR result;
788 register size_t copy_sz = lb;
789 register size_t old_sz;
792 if (p == 0) return(GC_debug_malloc(lb, OPT_RA s, i));
795 "Attempt to reallocate invalid pointer %lx\n", (unsigned long)p);
796 ABORT("realloc(invalid pointer)");
798 if ((ptr_t)p - (ptr_t)base != sizeof(oh)) {
800 "GC_debug_realloc called on pointer %lx wo debugging info\n",
802 return(GC_realloc(p, lb));
805 switch (hhdr -> hb_obj_kind) {
806 # ifdef STUBBORN_ALLOC
808 result = GC_debug_malloc_stubborn(lb, OPT_RA s, i);
812 result = GC_debug_malloc(lb, OPT_RA s, i);
815 result = GC_debug_malloc_atomic(lb, OPT_RA s, i);
818 result = GC_debug_malloc_uncollectable(lb, OPT_RA s, i);
820 # ifdef ATOMIC_UNCOLLECTABLE
822 result = GC_debug_malloc_atomic_uncollectable(lb, OPT_RA s, i);
826 GC_err_printf0("GC_debug_realloc: encountered bad kind\n");
829 # ifdef SHORT_DBG_HDRS
830 old_sz = GC_size(base) - sizeof(oh);
832 clobbered = GC_check_annotated_obj((oh *)base);
833 if (clobbered != 0) {
834 GC_err_printf0("GC_debug_realloc: found smashed location at ");
835 GC_print_smashed_obj(p, clobbered);
837 old_sz = ((oh *)base) -> oh_sz;
839 if (old_sz < copy_sz) copy_sz = old_sz;
840 if (result == 0) return(0);
841 BCOPY(p, result, copy_sz);
846 #ifndef SHORT_DBG_HDRS
848 /* List of smashed objects. We defer printing these, since we can't */
849 /* always print them nicely with the allocation lock held. */
850 /* We put them here instead of in GC_arrays, since it may be useful to */
851 /* be able to look at them with the debugger. */
852 #define MAX_SMASHED 20
853 ptr_t GC_smashed[MAX_SMASHED];
854 unsigned GC_n_smashed = 0;
856 # if defined(__STDC__) || defined(__cplusplus)
857 void GC_add_smashed(ptr_t smashed)
859 void GC_add_smashed(smashed)
863 GC_ASSERT(GC_is_marked(GC_base(smashed)));
864 GC_smashed[GC_n_smashed] = smashed;
865 if (GC_n_smashed < MAX_SMASHED - 1) ++GC_n_smashed;
866 /* In case of overflow, we keep the first MAX_SMASHED-1 */
867 /* entries plus the last one. */
868 GC_have_errors = TRUE;
871 /* Print all objects on the list. Clear the list. */
872 void GC_print_all_smashed_proc ()
876 GC_ASSERT(!I_HOLD_LOCK());
877 if (GC_n_smashed == 0) return;
878 GC_err_printf0("GC_check_heap_block: found smashed heap objects:\n");
879 for (i = 0; i < GC_n_smashed; ++i) {
880 GC_print_smashed_obj(GC_base(GC_smashed[i]), GC_smashed[i]);
886 /* Check all marked objects in the given block for validity */
888 # if defined(__STDC__) || defined(__cplusplus)
889 void GC_check_heap_block(register struct hblk *hbp, word dummy)
891 void GC_check_heap_block(hbp, dummy)
892 register struct hblk *hbp; /* ptr to current heap block */
896 register struct hblkhdr * hhdr = HDR(hbp);
897 register word sz = hhdr -> hb_sz;
898 register int word_no;
899 register word *p, *plim;
901 p = (word *)(hbp->hb_body);
906 plim = (word *)((((word)hbp) + HBLKSIZE) - WORDS_TO_BYTES(sz));
908 /* go through all words in block */
910 if( mark_bit_from_hdr(hhdr, word_no)
911 && GC_HAS_DEBUG_INFO((ptr_t)p)) {
912 ptr_t clobbered = GC_check_annotated_obj((oh *)p);
914 if (clobbered != 0) GC_add_smashed(clobbered);
922 /* This assumes that all accessible objects are marked, and that */
923 /* I hold the allocation lock. Normally called by collector. */
924 void GC_check_heap_proc()
926 # ifndef SMALL_CONFIG
928 GC_STATIC_ASSERT((sizeof(oh) & (2 * sizeof(word) - 1)) == 0);
930 GC_STATIC_ASSERT((sizeof(oh) & (sizeof(word) - 1)) == 0);
933 GC_apply_to_all_blocks(GC_check_heap_block, (word)0);
936 #endif /* !SHORT_DBG_HDRS */
939 GC_finalization_proc cl_fn;
944 void * GC_make_closure(GC_finalization_proc fn, void * data)
946 GC_PTR GC_make_closure(fn, data)
947 GC_finalization_proc fn;
951 struct closure * result =
953 (struct closure *) GC_debug_malloc(sizeof (struct closure),
956 (struct closure *) GC_malloc(sizeof (struct closure));
959 result -> cl_fn = fn;
960 result -> cl_data = data;
961 return((GC_PTR)result);
965 void GC_debug_invoke_finalizer(void * obj, void * data)
967 void GC_debug_invoke_finalizer(obj, data)
972 register struct closure * cl = (struct closure *) data;
974 (*(cl -> cl_fn))((GC_PTR)((char *)obj + sizeof(oh)), cl -> cl_data);
977 /* Set ofn and ocd to reflect the values we got back. */
978 static void store_old (obj, my_old_fn, my_old_cd, ofn, ocd)
980 GC_finalization_proc my_old_fn;
981 struct closure * my_old_cd;
982 GC_finalization_proc *ofn;
985 if (0 != my_old_fn) {
986 if (my_old_fn != GC_debug_invoke_finalizer) {
987 GC_err_printf1("Debuggable object at 0x%lx had non-debug finalizer.\n",
989 /* This should probably be fatal. */
991 if (ofn) *ofn = my_old_cd -> cl_fn;
992 if (ocd) *ocd = my_old_cd -> cl_data;
1001 void GC_debug_register_finalizer(GC_PTR obj, GC_finalization_proc fn,
1002 GC_PTR cd, GC_finalization_proc *ofn,
1005 void GC_debug_register_finalizer(obj, fn, cd, ofn, ocd)
1007 GC_finalization_proc fn;
1009 GC_finalization_proc *ofn;
1013 GC_finalization_proc my_old_fn;
1015 ptr_t base = GC_base(obj);
1016 if (0 == base || (ptr_t)obj - base != sizeof(oh)) {
1018 "GC_debug_register_finalizer called with non-base-pointer 0x%lx\n",
1022 GC_register_finalizer(base, 0, 0, &my_old_fn, &my_old_cd);
1024 GC_register_finalizer(base, GC_debug_invoke_finalizer,
1025 GC_make_closure(fn,cd), &my_old_fn, &my_old_cd);
1027 store_old(obj, my_old_fn, (struct closure *)my_old_cd, ofn, ocd);
1031 void GC_debug_register_finalizer_no_order
1032 (GC_PTR obj, GC_finalization_proc fn,
1033 GC_PTR cd, GC_finalization_proc *ofn,
1036 void GC_debug_register_finalizer_no_order
1037 (obj, fn, cd, ofn, ocd)
1039 GC_finalization_proc fn;
1041 GC_finalization_proc *ofn;
1045 GC_finalization_proc my_old_fn;
1047 ptr_t base = GC_base(obj);
1048 if (0 == base || (ptr_t)obj - base != sizeof(oh)) {
1050 "GC_debug_register_finalizer_no_order called with non-base-pointer 0x%lx\n",
1054 GC_register_finalizer_no_order(base, 0, 0, &my_old_fn, &my_old_cd);
1056 GC_register_finalizer_no_order(base, GC_debug_invoke_finalizer,
1057 GC_make_closure(fn,cd), &my_old_fn,
1060 store_old(obj, my_old_fn, (struct closure *)my_old_cd, ofn, ocd);
1064 void GC_debug_register_finalizer_ignore_self
1065 (GC_PTR obj, GC_finalization_proc fn,
1066 GC_PTR cd, GC_finalization_proc *ofn,
1069 void GC_debug_register_finalizer_ignore_self
1070 (obj, fn, cd, ofn, ocd)
1072 GC_finalization_proc fn;
1074 GC_finalization_proc *ofn;
1078 GC_finalization_proc my_old_fn;
1080 ptr_t base = GC_base(obj);
1081 if (0 == base || (ptr_t)obj - base != sizeof(oh)) {
1083 "GC_debug_register_finalizer_ignore_self called with non-base-pointer 0x%lx\n",
1087 GC_register_finalizer_ignore_self(base, 0, 0, &my_old_fn, &my_old_cd);
1089 GC_register_finalizer_ignore_self(base, GC_debug_invoke_finalizer,
1090 GC_make_closure(fn,cd), &my_old_fn,
1093 store_old(obj, my_old_fn, (struct closure *)my_old_cd, ofn, ocd);
1096 #ifdef GC_ADD_CALLER
1097 # define RA GC_RETURN_ADDR,
1102 GC_PTR GC_debug_malloc_replacement(lb)
1105 return GC_debug_malloc(lb, RA "unknown", 0);
1108 GC_PTR GC_debug_realloc_replacement(p, lb)
1112 return GC_debug_realloc(p, lb, RA "unknown", 0);