2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1994 by Xerox Corporation. All rights reserved.
5 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
6 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
8 * Permission is hereby granted to use or copy this program
9 * for any purpose, provided the above notices are retained on all copies.
10 * Permission to modify the code and to distribute modified code is granted,
11 * provided the above notices are retained, and a notice that the code was
12 * modified is included with the above copyright notice.
14 /* Boehm, February 16, 1996 2:30 pm PST */
20 #if defined(mips) && defined(SYSTYPE_BSD) && defined(sony_news)
21 /* sony RISC NEWS, NEWSOS 4 */
23 /* typedef long ptrdiff_t; -- necessary on some really old systems */
26 #if defined(mips) && defined(SYSTYPE_BSD43)
32 # include <sys/types.h>
33 # include <sys/time.h>
34 # include <sys/resource.h>
42 typedef GC_signed_word signed_word;
45 # include "gcconfig.h"
56 typedef char * ptr_t; /* A generic pointer to which we can add */
57 /* byte displacements. */
58 /* Preferably identical to caddr_t, if it */
63 # if !(defined( sony_news ) )
66 # define VOLATILE volatile
82 /*********************************/
84 /* Definitions for conservative */
87 /*********************************/
89 /*********************************/
91 /* Easily changeable parameters */
93 /*********************************/
95 #define STUBBORN_ALLOC /* Define stubborn allocation primitives */
96 #if defined(SRC_M3) || defined(SMALL_CONFIG)
97 # undef STUBBORN_ALLOC
101 /* #define ALL_INTERIOR_POINTERS */
102 /* Forces all pointers into the interior of an */
103 /* object to be considered valid. Also causes the */
104 /* sizes of all objects to be inflated by at least */
105 /* one byte. This should suffice to guarantee */
106 /* that in the presence of a compiler that does */
107 /* not perform garbage-collector-unsafe */
108 /* optimizations, all portable, strictly ANSI */
109 /* conforming C programs should be safely usable */
110 /* with malloc replaced by GC_malloc and free */
111 /* calls removed. There are several disadvantages: */
112 /* 1. There are probably no interesting, portable, */
113 /* strictly ANSI conforming C programs. */
114 /* 2. This option makes it hard for the collector */
115 /* to allocate space that is not ``pointed to'' */
116 /* by integers, etc. Under SunOS 4.X with a */
117 /* statically linked libc, we empiricaly */
118 /* observed that it would be difficult to */
119 /* allocate individual objects larger than 100K. */
120 /* Even if only smaller objects are allocated, */
121 /* more swap space is likely to be needed. */
122 /* Fortunately, much of this will never be */
124 /* If you can easily avoid using this option, do. */
125 /* If not, try to keep individual objects small. */
127 #define PRINTSTATS /* Print garbage collection statistics */
128 /* For less verbose output, undefine in reclaim.c */
130 #define PRINTTIMES /* Print the amount of time consumed by each garbage */
133 #define PRINTBLOCKS /* Print object sizes associated with heap blocks, */
134 /* whether the objects are atomic or composite, and */
135 /* whether or not the block was found to be empty */
136 /* during the reclaim phase. Typically generates */
137 /* about one screenful per garbage collection. */
152 #if defined(PRINTSTATS) && !defined(GATHERSTATS)
156 #ifdef FINALIZE_ON_DEMAND
157 # define GC_INVOKE_FINALIZERS()
159 # define GC_INVOKE_FINALIZERS() (void)GC_invoke_finalizers()
162 #define MERGE_SIZES /* Round up some object sizes, so that fewer distinct */
163 /* free lists are actually maintained. This applies */
164 /* only to the top level routines in misc.c, not to */
165 /* user generated code that calls GC_allocobj and */
166 /* GC_allocaobj directly. */
167 /* Slows down average programs slightly. May however */
168 /* substantially reduce fragmentation if allocation */
169 /* request sizes are widely scattered. */
170 /* May save significant amounts of space for obj_map */
173 #ifndef OLD_BLOCK_ALLOC
174 /* Macros controlling large block allocation strategy. */
175 # define EXACT_FIRST /* Make a complete pass through the large object */
176 /* free list before splitting a block */
177 # define PRESERVE_LAST /* Do not divide last allocated heap segment */
178 /* unless we would otherwise need to expand the */
182 /* ALIGN_DOUBLE requires MERGE_SIZES at present. */
183 # if defined(ALIGN_DOUBLE) && !defined(MERGE_SIZES)
187 #if defined(ALL_INTERIOR_POINTERS) && !defined(DONT_ADD_BYTE_AT_END)
188 # define ADD_BYTE_AT_END
192 # ifndef LARGE_CONFIG
193 # define MINHINCR 16 /* Minimum heap increment, in blocks of HBLKSIZE */
194 /* Must be multiple of largest page size. */
195 # define MAXHINCR 512 /* Maximum heap increment, in blocks */
198 # define MAXHINCR 4096
201 # define TIME_LIMIT 50 /* We try to keep pause times from exceeding */
202 /* this by much. In milliseconds. */
204 # define BL_LIMIT GC_black_list_spacing
205 /* If we need a block of N bytes, and we have */
206 /* a block of N + BL_LIMIT bytes available, */
207 /* and N > BL_LIMIT, */
208 /* but all possible positions in it are */
209 /* blacklisted, we just use it anyway (and */
210 /* print a warning, if warnings are enabled). */
211 /* This risks subsequently leaking the block */
212 /* due to a false reference. But not using */
213 /* the block risks unreasonable immediate */
216 /*********************************/
218 /* Stack saving for debugging */
220 /*********************************/
222 #ifdef SAVE_CALL_CHAIN
225 * Number of frames and arguments to save in objects allocated by
226 * debugging allocator.
228 # define NFRAMES 6 /* Number of frames to save. Even for */
229 /* alignment reasons. */
230 # define NARGS 2 /* Mumber of arguments to save for each call. */
232 # define NEED_CALLINFO
234 /* Fill in the pc and argument information for up to NFRAMES of my */
235 /* callers. Ignore my frame and my callers frame. */
236 void GC_save_callers (/* struct callinfo info[NFRAMES] */);
238 void GC_print_callers (/* struct callinfo info[NFRAMES] */);
242 # ifdef GC_ADD_CALLER
245 # define NEED_CALLINFO
254 word ci_arg[NARGS]; /* bit-wise complement to avoid retention */
256 # if defined(ALIGN_DOUBLE) && (NFRAMES * (NARGS + 1)) % 2 == 1
257 /* Likely alignment problem. */
264 /*********************************/
266 /* OS interface routines */
268 /*********************************/
274 # define CLOCK_TYPE struct timeval
275 # define GET_TIME(x) { struct rusage rusage; \
276 getrusage (RUSAGE_SELF, &rusage); \
277 x = rusage.ru_utime; }
278 # define MS_TIME_DIFF(a,b) ((double) (a.tv_sec - b.tv_sec) * 1000.0 \
279 + (double) (a.tv_usec - b.tv_usec) / 1000.0)
280 #else /* !BSD_TIME */
282 # if !defined(__STDC__) && defined(SPARC) && defined(SUNOS4)
283 clock_t clock(); /* Not in time.h, where it belongs */
285 # if defined(FREEBSD) && !defined(CLOCKS_PER_SEC)
286 # include <machine/limits.h>
287 # define CLOCKS_PER_SEC CLK_TCK
289 # if !defined(CLOCKS_PER_SEC)
290 # define CLOCKS_PER_SEC 1000000
292 * This is technically a bug in the implementation. ANSI requires that
293 * CLOCKS_PER_SEC be defined. But at least under SunOS4.1.1, it isn't.
294 * Also note that the combination of ANSI C and POSIX is incredibly gross
295 * here. The type clock_t is used by both clock() and times(). But on
296 * some machines these use different notions of a clock tick, CLOCKS_PER_SEC
297 * seems to apply only to clock. Hence we use it here. On many machines,
298 * including SunOS, clock actually uses units of microseconds (which are
299 * not really clock ticks).
302 # define CLOCK_TYPE clock_t
303 # define GET_TIME(x) x = clock()
304 # define MS_TIME_DIFF(a,b) ((unsigned long) \
305 (1000.0*(double)((a)-(b))/(double)CLOCKS_PER_SEC))
306 #endif /* !BSD_TIME */
308 /* We use bzero and bcopy internally. They may not be available. */
309 # if defined(SPARC) && defined(SUNOS4)
310 # define BCOPY_EXISTS
312 # if defined(M68K) && defined(AMIGA)
313 # define BCOPY_EXISTS
315 # if defined(M68K) && defined(NEXT)
316 # define BCOPY_EXISTS
319 # define BCOPY_EXISTS
323 # define BCOPY_EXISTS
326 # ifndef BCOPY_EXISTS
328 # define BCOPY(x,y,n) memcpy(y, x, (size_t)(n))
329 # define BZERO(x,n) memset(x, 0, (size_t)(n))
331 # define BCOPY(x,y,n) bcopy((char *)(x),(char *)(y),(int)(n))
332 # define BZERO(x,n) bzero((char *)(x),(int)(n))
335 /* HBLKSIZE aligned allocation. 0 is taken to mean failure */
336 /* space is assumed to be cleared. */
337 /* In the case os USE_MMAP, the argument must also be a */
338 /* physical page size. */
340 char * real_malloc();
341 # define GET_MEM(bytes) HBLKPTR(real_malloc((size_t)bytes + GC_page_size) \
345 void * os2_alloc(size_t bytes);
346 # define GET_MEM(bytes) HBLKPTR((ptr_t)os2_alloc((size_t)bytes \
350 # if defined(AMIGA) || defined(NEXT) || defined(DOS4GW)
351 # define GET_MEM(bytes) HBLKPTR((size_t) \
352 calloc(1, (size_t)bytes + GC_page_size) \
356 extern ptr_t GC_win32_get_mem();
357 # define GET_MEM(bytes) (struct hblk *)GC_win32_get_mem(bytes)
360 # if defined(USE_TEMPORARY_MEMORY)
361 extern Ptr GC_MacTemporaryNewPtr(size_t size,
362 Boolean clearMemory);
363 # define GET_MEM(bytes) HBLKPTR( \
364 GC_MacTemporaryNewPtr(bytes + GC_page_size, true) \
367 # define GET_MEM(bytes) HBLKPTR( \
368 NewPtrClear(bytes + GC_page_size) + GC_page_size-1)
371 extern ptr_t GC_unix_get_mem();
372 # define GET_MEM(bytes) (struct hblk *)GC_unix_get_mem(bytes)
380 * Mutual exclusion between allocator/collector routines.
381 * Needed if there is more than one allocator thread.
382 * FASTLOCK() is assumed to try to acquire the lock in a cheap and
383 * dirty way that is acceptable for a few instructions, e.g. by
384 * inhibiting preemption. This is assumed to have succeeded only
385 * if a subsequent call to FASTLOCK_SUCCEEDED() returns TRUE.
386 * FASTUNLOCK() is called whether or not FASTLOCK_SUCCEEDED().
387 * If signals cannot be tolerated with the FASTLOCK held, then
388 * FASTLOCK should disable signals. The code executed under
389 * FASTLOCK is otherwise immune to interruption, provided it is
391 * DCL_LOCK_STATE declares any local variables needed by LOCK and UNLOCK
392 * and/or DISABLE_SIGNALS and ENABLE_SIGNALS and/or FASTLOCK.
393 * (There is currently no equivalent for FASTLOCK.)
396 # ifdef PCR_OBSOLETE /* Faster, but broken with multiple lwp's */
397 # include "th/PCR_Th.h"
398 # include "th/PCR_ThCrSec.h"
399 extern struct PCR_Th_MLRep GC_allocate_ml;
400 # define DCL_LOCK_STATE PCR_sigset_t GC_old_sig_mask
401 # define LOCK() PCR_Th_ML_Acquire(&GC_allocate_ml)
402 # define UNLOCK() PCR_Th_ML_Release(&GC_allocate_ml)
403 # define FASTLOCK() PCR_ThCrSec_EnterSys()
404 /* Here we cheat (a lot): */
405 # define FASTLOCK_SUCCEEDED() (*(int *)(&GC_allocate_ml) == 0)
406 /* TRUE if nobody currently holds the lock */
407 # define FASTUNLOCK() PCR_ThCrSec_ExitSys()
410 # include <base/PCR_Base.h>
411 # include <th/PCR_Th.h>
412 extern PCR_Th_ML GC_allocate_ml;
413 # define DCL_LOCK_STATE \
414 PCR_ERes GC_fastLockRes; PCR_sigset_t GC_old_sig_mask
415 # define LOCK() PCR_Th_ML_Acquire(&GC_allocate_ml)
416 # define UNLOCK() PCR_Th_ML_Release(&GC_allocate_ml)
417 # define FASTLOCK() (GC_fastLockRes = PCR_Th_ML_Try(&GC_allocate_ml))
418 # define FASTLOCK_SUCCEEDED() (GC_fastLockRes == PCR_ERes_okay)
419 # define FASTUNLOCK() {\
420 if( FASTLOCK_SUCCEEDED() ) PCR_Th_ML_Release(&GC_allocate_ml); }
423 extern word RT0u__inCritical;
424 # define LOCK() RT0u__inCritical++
425 # define UNLOCK() RT0u__inCritical--
427 # ifdef SOLARIS_THREADS
430 extern mutex_t GC_allocate_ml;
431 # define LOCK() mutex_lock(&GC_allocate_ml);
432 # define UNLOCK() mutex_unlock(&GC_allocate_ml);
434 # ifdef LINUX_THREADS
435 # include <pthread.h>
437 inline static GC_test_and_set(volatile unsigned int *addr) {
439 /* Note: the "xchg" instruction does not need a "lock" prefix */
440 __asm__ __volatile__("xchgl %0, %1"
441 : "=r"(oldval), "=m"(*(addr))
442 : "0"(1), "m"(*(addr)));
446 -- > Need implementation of GC_test_and_set()
448 # define GC_clear(addr) (*(addr) = 0)
450 extern volatile unsigned int GC_allocate_lock;
451 /* This is not a mutex because mutexes that obey the (optional) */
452 /* POSIX scheduling rules are subject to convoys in high contention */
453 /* applications. This is basically a spin lock. */
454 extern pthread_t GC_lock_holder;
455 extern void GC_lock(void);
456 /* Allocation lock holder. Only set if acquired by client through */
457 /* GC_call_with_alloc_lock. */
458 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
459 # define NO_THREAD (pthread_t)(-1)
460 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
461 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
463 # define LOCK() pthread_mutex_lock(&GC_allocate_ml)
464 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
467 { if (GC_test_and_set(&GC_allocate_lock)) GC_lock(); }
469 GC_clear(&GC_allocate_lock)
471 extern GC_bool GC_collecting;
472 # define ENTER_GC() \
476 # define EXIT_GC() GC_collecting = 0;
477 # endif /* LINUX_THREADS */
478 # if defined(IRIX_THREADS) || defined(IRIX_JDK_THREADS)
479 # include <pthread.h>
482 # if __mips < 3 || !(defined (_ABIN32) || defined(_ABI64))
483 # define GC_test_and_set(addr, v) test_and_set(addr,v)
485 # define GC_test_and_set(addr, v) __test_and_set(addr,v)
487 extern unsigned long GC_allocate_lock;
488 /* This is not a mutex because mutexes that obey the (optional) */
489 /* POSIX scheduling rules are subject to convoys in high contention */
490 /* applications. This is basically a spin lock. */
491 extern pthread_t GC_lock_holder;
492 extern void GC_lock(void);
493 /* Allocation lock holder. Only set if acquired by client through */
494 /* GC_call_with_alloc_lock. */
495 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
496 # define NO_THREAD (pthread_t)(-1)
497 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
498 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
500 # define LOCK() pthread_mutex_lock(&GC_allocate_ml)
501 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
503 # define LOCK() { if (GC_test_and_set(&GC_allocate_lock, 1)) GC_lock(); }
504 # if __mips >= 3 && (defined (_ABIN32) || defined(_ABI64))
505 # define UNLOCK() __lock_release(&GC_allocate_lock)
507 # define UNLOCK() GC_allocate_lock = 0
510 extern GC_bool GC_collecting;
511 # define ENTER_GC() \
515 # define EXIT_GC() GC_collecting = 0;
516 # endif /* IRIX_THREADS || IRIX_JDK_THREADS */
517 # ifdef WIN32_THREADS
518 # include <windows.h>
519 GC_API CRITICAL_SECTION GC_allocate_ml;
520 # define LOCK() EnterCriticalSection(&GC_allocate_ml);
521 # define UNLOCK() LeaveCriticalSection(&GC_allocate_ml);
523 # ifndef SET_LOCK_HOLDER
524 # define SET_LOCK_HOLDER()
525 # define UNSET_LOCK_HOLDER()
526 # define I_HOLD_LOCK() FALSE
527 /* Used on platforms were locks can be reacquired, */
528 /* so it doesn't matter if we lie. */
534 # ifndef SET_LOCK_HOLDER
535 # define SET_LOCK_HOLDER()
536 # define UNSET_LOCK_HOLDER()
537 # define I_HOLD_LOCK() FALSE
538 /* Used on platforms were locks can be reacquired, */
539 /* so it doesn't matter if we lie. */
546 # ifndef DCL_LOCK_STATE
547 # define DCL_LOCK_STATE
550 # define FASTLOCK() LOCK()
551 # define FASTLOCK_SUCCEEDED() TRUE
552 # define FASTUNLOCK() UNLOCK()
555 /* Delay any interrupts or signals that may abort this thread. Data */
556 /* structures are in a consistent state outside this pair of calls. */
557 /* ANSI C allows both to be empty (though the standard isn't very */
558 /* clear on that point). Standard malloc implementations are usually */
559 /* neither interruptable nor thread-safe, and thus correspond to */
560 /* empty definitions. */
562 # define DISABLE_SIGNALS() \
563 PCR_Th_SetSigMask(PCR_allSigsBlocked,&GC_old_sig_mask)
564 # define ENABLE_SIGNALS() \
565 PCR_Th_SetSigMask(&GC_old_sig_mask, NIL)
567 # if defined(SRC_M3) || defined(AMIGA) || defined(SOLARIS_THREADS) \
568 || defined(MSWIN32) || defined(MACOS) || defined(DJGPP) \
569 || defined(NO_SIGNALS) || defined(IRIX_THREADS) \
570 || defined(IRIX_JDK_THREADS) || defined(LINUX_THREADS)
571 /* Also useful for debugging. */
572 /* Should probably use thr_sigsetmask for SOLARIS_THREADS. */
573 # define DISABLE_SIGNALS()
574 # define ENABLE_SIGNALS()
576 # define DISABLE_SIGNALS() GC_disable_signals()
577 void GC_disable_signals();
578 # define ENABLE_SIGNALS() GC_enable_signals()
579 void GC_enable_signals();
584 * Stop and restart mutator threads.
587 # include "th/PCR_ThCtl.h"
588 # define STOP_WORLD() \
589 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_stopNormal, \
590 PCR_allSigsBlocked, \
592 # define START_WORLD() \
593 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_null, \
594 PCR_allSigsBlocked, \
597 # if defined(SOLARIS_THREADS) || defined(WIN32_THREADS) \
598 || defined(IRIX_THREADS) || defined(LINUX_THREADS) \
599 || defined(IRIX_JDK_THREADS)
600 void GC_stop_world();
601 void GC_start_world();
602 # define STOP_WORLD() GC_stop_world()
603 # define START_WORLD() GC_start_world()
605 # define STOP_WORLD()
606 # define START_WORLD()
612 # define ABORT(s) PCR_Base_Panic(s)
615 # define ABORT(msg) abort();
617 GC_API void GC_abort();
618 # define ABORT(msg) GC_abort(msg);
622 /* Exit abnormally, but without making a mess (e.g. out of memory) */
624 # define EXIT() PCR_Base_Exit(1,PCR_waitForever)
626 # define EXIT() (void)exit(1)
629 /* Print warning message, e.g. almost out of memory. */
630 # define WARN(msg,arg) (*GC_current_warn_proc)(msg, (GC_word)(arg))
631 extern GC_warn_proc GC_current_warn_proc;
633 /*********************************/
635 /* Word-size-dependent defines */
637 /*********************************/
640 # define WORDS_TO_BYTES(x) ((x)<<2)
641 # define BYTES_TO_WORDS(x) ((x)>>2)
642 # define LOGWL ((word)5) /* log[2] of CPP_WORDSZ */
643 # define modWORDSZ(n) ((n) & 0x1f) /* n mod size of word */
650 # define WORDS_TO_BYTES(x) ((x)<<3)
651 # define BYTES_TO_WORDS(x) ((x)>>3)
652 # define LOGWL ((word)6) /* log[2] of CPP_WORDSZ */
653 # define modWORDSZ(n) ((n) & 0x3f) /* n mod size of word */
659 #define WORDSZ ((word)CPP_WORDSZ)
660 #define SIGNB ((word)1 << (WORDSZ-1))
661 #define BYTES_PER_WORD ((word)(sizeof (word)))
662 #define ONES ((word)(-1))
663 #define divWORDSZ(n) ((n) >> LOGWL) /* divide n by size of word */
665 /*********************/
667 /* Size Parameters */
669 /*********************/
671 /* heap block size, bytes. Should be power of 2 */
675 # define CPP_LOG_HBLKSIZE 10
677 # if CPP_WORDSZ == 32
678 # define CPP_LOG_HBLKSIZE 12
680 # define CPP_LOG_HBLKSIZE 13
685 # define CPP_LOG_HBLKSIZE 9
687 # if HBLKSIZE == 1024
688 # define CPP_LOG_HBLKSIZE 10
690 # if HBLKSIZE == 2048
691 # define CPP_LOG_HBLKSIZE 11
693 # if HBLKSIZE == 4096
694 # define CPP_LOG_HBLKSIZE 12
696 # if HBLKSIZE == 8192
697 # define CPP_LOG_HBLKSIZE 13
699 # if HBLKSIZE == 16384
700 # define CPP_LOG_HBLKSIZE 14
702 # ifndef CPP_LOG_HBLKSIZE
707 # define CPP_HBLKSIZE (1 << CPP_LOG_HBLKSIZE)
708 # define LOG_HBLKSIZE ((word)CPP_LOG_HBLKSIZE)
709 # define HBLKSIZE ((word)CPP_HBLKSIZE)
712 /* max size objects supported by freelist (larger objects may be */
713 /* allocated, but less efficiently) */
715 #define CPP_MAXOBJSZ BYTES_TO_WORDS(CPP_HBLKSIZE/2)
716 #define MAXOBJSZ ((word)CPP_MAXOBJSZ)
718 # define divHBLKSZ(n) ((n) >> LOG_HBLKSIZE)
720 # define HBLK_PTR_DIFF(p,q) divHBLKSZ((ptr_t)p - (ptr_t)q)
721 /* Equivalent to subtracting 2 hblk pointers. */
722 /* We do it this way because a compiler should */
723 /* find it hard to use an integer division */
724 /* instead of a shift. The bundled SunOS 4.1 */
725 /* o.w. sometimes pessimizes the subtraction to */
726 /* involve a call to .div. */
728 # define modHBLKSZ(n) ((n) & (HBLKSIZE-1))
730 # define HBLKPTR(objptr) ((struct hblk *)(((word) (objptr)) & ~(HBLKSIZE-1)))
732 # define HBLKDISPL(objptr) (((word) (objptr)) & (HBLKSIZE-1))
734 /* Round up byte allocation requests to integral number of words, etc. */
735 # ifdef ADD_BYTE_AT_END
736 # define ROUNDED_UP_WORDS(n) BYTES_TO_WORDS((n) + WORDS_TO_BYTES(1))
738 # define ALIGNED_WORDS(n) (BYTES_TO_WORDS((n) + WORDS_TO_BYTES(2)) & ~1)
740 # define ALIGNED_WORDS(n) ROUNDED_UP_WORDS(n)
742 # define SMALL_OBJ(bytes) ((bytes) < WORDS_TO_BYTES(MAXOBJSZ))
743 # define ADD_SLOP(bytes) ((bytes)+1)
745 # define ROUNDED_UP_WORDS(n) BYTES_TO_WORDS((n) + (WORDS_TO_BYTES(1) - 1))
747 # define ALIGNED_WORDS(n) \
748 (BYTES_TO_WORDS((n) + WORDS_TO_BYTES(2) - 1) & ~1)
750 # define ALIGNED_WORDS(n) ROUNDED_UP_WORDS(n)
752 # define SMALL_OBJ(bytes) ((bytes) <= WORDS_TO_BYTES(MAXOBJSZ))
753 # define ADD_SLOP(bytes) (bytes)
758 * Hash table representation of sets of pages. This assumes it is
759 * OK to add spurious entries to sets.
760 * Used by black-listing code, and perhaps by dirty bit maintenance code.
764 # define LOG_PHT_ENTRIES 17
766 # define LOG_PHT_ENTRIES 14 /* Collisions are likely if heap grows */
767 /* to more than 16K hblks = 64MB. */
768 /* Each hash table occupies 2K bytes. */
770 # define PHT_ENTRIES ((word)1 << LOG_PHT_ENTRIES)
771 # define PHT_SIZE (PHT_ENTRIES >> LOGWL)
772 typedef word page_hash_table[PHT_SIZE];
774 # define PHT_HASH(addr) ((((word)(addr)) >> LOG_HBLKSIZE) & (PHT_ENTRIES - 1))
776 # define get_pht_entry_from_index(bl, index) \
777 (((bl)[divWORDSZ(index)] >> modWORDSZ(index)) & 1)
778 # define set_pht_entry_from_index(bl, index) \
779 (bl)[divWORDSZ(index)] |= (word)1 << modWORDSZ(index)
780 # define clear_pht_entry_from_index(bl, index) \
781 (bl)[divWORDSZ(index)] &= ~((word)1 << modWORDSZ(index))
785 /********************************************/
787 /* H e a p B l o c k s */
789 /********************************************/
791 /* heap block header */
792 #define HBLKMASK (HBLKSIZE-1)
794 #define BITS_PER_HBLK (HBLKSIZE * 8)
796 #define MARK_BITS_PER_HBLK (BITS_PER_HBLK/CPP_WORDSZ)
798 /* We allocate 1 bit/word. Only the first word */
799 /* in each object is actually marked. */
802 # define MARK_BITS_SZ (((MARK_BITS_PER_HBLK + 2*CPP_WORDSZ - 1) \
805 # define MARK_BITS_SZ ((MARK_BITS_PER_HBLK + CPP_WORDSZ - 1)/CPP_WORDSZ)
807 /* Upper bound on number of mark words per heap block */
810 word hb_sz; /* If in use, size in words, of objects in the block. */
811 /* if free, the size in bytes of the whole block */
812 struct hblk * hb_next; /* Link field for hblk free list */
813 /* and for lists of chunks waiting to be */
815 word hb_descr; /* object descriptor for marking. See */
817 char* hb_map; /* A pointer to a pointer validity map of the block. */
818 /* See GC_obj_map. */
819 /* Valid for all blocks with headers. */
820 /* Free blocks point to GC_invalid_map. */
821 unsigned char hb_obj_kind;
822 /* Kind of objects in the block. Each kind */
823 /* identifies a mark procedure and a set of */
824 /* list headers. Sometimes called regions. */
825 unsigned char hb_flags;
826 # define IGNORE_OFF_PAGE 1 /* Ignore pointers that do not */
827 /* point to the first page of */
829 unsigned short hb_last_reclaimed;
830 /* Value of GC_gc_no when block was */
831 /* last allocated or swept. May wrap. */
832 word hb_marks[MARK_BITS_SZ];
833 /* Bit i in the array refers to the */
834 /* object starting at the ith word (header */
835 /* INCLUDED) in the heap block. */
836 /* The lsb of word 0 is numbered 0. */
839 /* heap block body */
841 # define DISCARD_WORDS 0
842 /* Number of words to be dropped at the beginning of each block */
843 /* Must be a multiple of WORDSZ. May reasonably be nonzero */
844 /* on machines that don't guarantee longword alignment of */
845 /* pointers, so that the number of false hits is minimized. */
846 /* 0 and WORDSZ are probably the only reasonable values. */
848 # define BODY_SZ ((HBLKSIZE-WORDS_TO_BYTES(DISCARD_WORDS))/sizeof(word))
851 # if (DISCARD_WORDS != 0)
852 word garbage[DISCARD_WORDS];
854 word hb_body[BODY_SZ];
857 # define HDR_WORDS ((word)DISCARD_WORDS)
858 # define HDR_BYTES ((word)WORDS_TO_BYTES(DISCARD_WORDS))
860 # define OBJ_SZ_TO_BLOCKS(sz) \
861 divHBLKSZ(HDR_BYTES + WORDS_TO_BYTES(sz) + HBLKSIZE-1)
862 /* Size of block (in units of HBLKSIZE) needed to hold objects of */
863 /* given sz (in words). */
865 /* Object free list link */
866 # define obj_link(p) (*(ptr_t *)(p))
868 /* The type of mark procedures. This really belongs in gc_mark.h. */
869 /* But we put it here, so that we can avoid scanning the mark proc */
871 typedef struct ms_entry * (*mark_proc)(/* word * addr, mark_stack_ptr,
872 mark_stack_limit, env */);
873 # define LOG_MAX_MARK_PROCS 6
874 # define MAX_MARK_PROCS (1 << LOG_MAX_MARK_PROCS)
876 /* Root sets. Logically private to mark_rts.c. But we don't want the */
877 /* tables scanned, so we put them here. */
878 /* MAX_ROOT_SETS is the maximum number of ranges that can be */
879 /* registered as static roots. */
881 # define MAX_ROOT_SETS 4096
884 # define MAX_ROOT_SETS 1024
887 # define MAX_ROOT_SETS 512
888 /* Under NT, we add only written pages, which can result */
889 /* in many small root sets. */
891 # define MAX_ROOT_SETS 64
896 # define MAX_EXCLUSIONS (MAX_ROOT_SETS/4)
897 /* Maximum number of segments that can be excluded from root sets. */
900 * Data structure for excluded static roots.
907 /* Data structure for list of root sets. */
908 /* We keep a hash table, so that we can filter out duplicate additions. */
909 /* Under Win32, we need to do a better job of filtering overlaps, so */
910 /* we resort to sequential search, and pay the price. */
915 struct roots * r_next;
918 /* Delete before registering new dynamic libraries */
922 /* Size of hash table index to roots. */
923 # define LOG_RT_SIZE 6
924 # define RT_SIZE (1 << LOG_RT_SIZE) /* Power of 2, may be != MAX_ROOT_SETS */
927 /* Lists of all heap blocks and free lists */
928 /* as well as other random data structures */
929 /* that should not be scanned by the */
931 /* These are grouped together in a struct */
932 /* so that they can be easily skipped by the */
933 /* GC_mark routine. */
934 /* The ordering is weird to make GC_malloc */
935 /* faster by keeping the important fields */
936 /* sufficiently close together that a */
937 /* single load of a base register will do. */
938 /* Scalars that could easily appear to */
939 /* be pointers are also put here. */
940 /* The main fields should precede any */
941 /* conditionally included fields, so that */
942 /* gc_inl.h will work even if a different set */
943 /* of macros is defined when the client is */
949 ptr_t _last_heap_addr;
950 ptr_t _prev_heap_addr;
951 word _words_allocd_before_gc;
952 /* Number of words allocated before this */
953 /* collection cycle. */
955 /* Number of words allocated during this collection cycle */
957 /* Number of words wasted due to internal fragmentation */
958 /* in large objects, or due to dropping blacklisted */
959 /* blocks, since last gc. Approximate. */
960 word _words_finalized;
961 /* Approximate number of words in objects (and headers) */
962 /* That became ready for finalization in the last */
964 word _non_gc_bytes_at_gc;
965 /* Number of explicitly managed bytes of storage */
966 /* at last collection. */
968 /* Number of explicitly deallocated words of memory */
969 /* since last collection. */
970 mark_proc _mark_procs[MAX_MARK_PROCS];
971 /* Table of user-defined mark procedures. There is */
972 /* a small number of these, which can be referenced */
973 /* by DS_PROC mark descriptors. See gc_mark.h. */
974 ptr_t _objfreelist[MAXOBJSZ+1];
975 /* free list for objects */
976 ptr_t _aobjfreelist[MAXOBJSZ+1];
977 /* free list for atomic objs */
979 ptr_t _uobjfreelist[MAXOBJSZ+1];
980 /* uncollectable but traced objs */
981 /* objects on this and auobjfreelist */
982 /* are always marked, except during */
983 /* garbage collections. */
984 # ifdef ATOMIC_UNCOLLECTABLE
985 ptr_t _auobjfreelist[MAXOBJSZ+1];
987 /* uncollectable but traced objs */
990 word _composite_in_use;
991 /* Number of words in accessible composite */
994 /* Number of words in accessible atomic */
998 unsigned _size_map[WORDS_TO_BYTES(MAXOBJSZ+1)];
999 /* Number of words to allocate for a given allocation request in */
1003 # ifdef STUBBORN_ALLOC
1004 ptr_t _sobjfreelist[MAXOBJSZ+1];
1006 /* free list for immutable objects */
1007 ptr_t _obj_map[MAXOBJSZ+1];
1008 /* If not NIL, then a pointer to a map of valid */
1009 /* object addresses. _obj_map[sz][i] is j if the */
1010 /* address block_start+i is a valid pointer */
1011 /* to an object at */
1012 /* block_start+i&~3 - WORDS_TO_BYTES(j). */
1013 /* (If ALL_INTERIOR_POINTERS is defined, then */
1014 /* instead ((short *)(hbh_map[sz])[i] is j if */
1015 /* block_start+WORDS_TO_BYTES(i) is in the */
1016 /* interior of an object starting at */
1017 /* block_start+WORDS_TO_BYTES(i-j)). */
1018 /* It is OBJ_INVALID if */
1019 /* block_start+WORDS_TO_BYTES(i) is not */
1020 /* valid as a pointer to an object. */
1021 /* We assume all values of j <= OBJ_INVALID. */
1022 /* The zeroth entry corresponds to large objects.*/
1023 # ifdef ALL_INTERIOR_POINTERS
1024 # define map_entry_type short
1025 # define OBJ_INVALID 0x7fff
1026 # define MAP_ENTRY(map, bytes) \
1027 (((map_entry_type *)(map))[BYTES_TO_WORDS(bytes)])
1028 # define MAP_ENTRIES BYTES_TO_WORDS(HBLKSIZE)
1029 # define MAP_SIZE (MAP_ENTRIES * sizeof(map_entry_type))
1030 # define OFFSET_VALID(displ) TRUE
1031 # define CPP_MAX_OFFSET (HBLKSIZE - HDR_BYTES - 1)
1032 # define MAX_OFFSET ((word)CPP_MAX_OFFSET)
1034 # define map_entry_type char
1035 # define OBJ_INVALID 0x7f
1036 # define MAP_ENTRY(map, bytes) \
1038 # define MAP_ENTRIES HBLKSIZE
1039 # define MAP_SIZE MAP_ENTRIES
1040 # define CPP_MAX_OFFSET (WORDS_TO_BYTES(OBJ_INVALID) - 1)
1041 # define MAX_OFFSET ((word)CPP_MAX_OFFSET)
1042 # define VALID_OFFSET_SZ \
1043 (CPP_MAX_OFFSET > WORDS_TO_BYTES(CPP_MAXOBJSZ)? \
1045 : WORDS_TO_BYTES(CPP_MAXOBJSZ)+1)
1046 char _valid_offsets[VALID_OFFSET_SZ];
1047 /* GC_valid_offsets[i] == TRUE ==> i */
1048 /* is registered as a displacement. */
1049 # define OFFSET_VALID(displ) GC_valid_offsets[displ]
1050 char _modws_valid_offsets[sizeof(word)];
1051 /* GC_valid_offsets[i] ==> */
1052 /* GC_modws_valid_offsets[i%sizeof(word)] */
1054 # ifdef STUBBORN_ALLOC
1055 page_hash_table _changed_pages;
1056 /* Stubborn object pages that were changes since last call to */
1057 /* GC_read_changed. */
1058 page_hash_table _prev_changed_pages;
1059 /* Stubborn object pages that were changes before last call to */
1060 /* GC_read_changed. */
1062 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
1063 page_hash_table _grungy_pages; /* Pages that were dirty at last */
1064 /* GC_read_dirty. */
1066 # ifdef MPROTECT_VDB
1067 VOLATILE page_hash_table _dirty_pages;
1068 /* Pages dirtied since last GC_read_dirty. */
1071 page_hash_table _written_pages; /* Pages ever dirtied */
1073 # ifdef LARGE_CONFIG
1074 # if CPP_WORDSZ > 32
1075 # define MAX_HEAP_SECTS 4096 /* overflows at roughly 64 GB */
1077 # define MAX_HEAP_SECTS 768 /* Separately added heap sections. */
1080 # define MAX_HEAP_SECTS 256
1083 ptr_t hs_start; word hs_bytes;
1084 } _heap_sects[MAX_HEAP_SECTS];
1086 ptr_t _heap_bases[MAX_HEAP_SECTS];
1087 /* Start address of memory regions obtained from kernel. */
1089 struct roots _static_roots[MAX_ROOT_SETS];
1091 struct roots * _root_index[RT_SIZE];
1093 struct exclusion _excl_table[MAX_EXCLUSIONS];
1094 /* Block header index; see gc_headers.h */
1095 bottom_index * _all_nils;
1096 bottom_index * _top_index [TOP_SZ];
1097 #ifdef SAVE_CALL_CHAIN
1098 struct callinfo _last_stack[NFRAMES]; /* Stack at last garbage collection.*/
1099 /* Useful for debugging mysterious */
1100 /* object disappearances. */
1101 /* In the multithreaded case, we */
1102 /* currently only save the calling */
1107 GC_API GC_FAR struct _GC_arrays GC_arrays;
1109 # define GC_objfreelist GC_arrays._objfreelist
1110 # define GC_aobjfreelist GC_arrays._aobjfreelist
1111 # define GC_uobjfreelist GC_arrays._uobjfreelist
1112 # ifdef ATOMIC_UNCOLLECTABLE
1113 # define GC_auobjfreelist GC_arrays._auobjfreelist
1115 # define GC_sobjfreelist GC_arrays._sobjfreelist
1116 # define GC_valid_offsets GC_arrays._valid_offsets
1117 # define GC_modws_valid_offsets GC_arrays._modws_valid_offsets
1118 # ifdef STUBBORN_ALLOC
1119 # define GC_changed_pages GC_arrays._changed_pages
1120 # define GC_prev_changed_pages GC_arrays._prev_changed_pages
1122 # define GC_obj_map GC_arrays._obj_map
1123 # define GC_last_heap_addr GC_arrays._last_heap_addr
1124 # define GC_prev_heap_addr GC_arrays._prev_heap_addr
1125 # define GC_words_allocd GC_arrays._words_allocd
1126 # define GC_words_wasted GC_arrays._words_wasted
1127 # define GC_words_finalized GC_arrays._words_finalized
1128 # define GC_non_gc_bytes_at_gc GC_arrays._non_gc_bytes_at_gc
1129 # define GC_mem_freed GC_arrays._mem_freed
1130 # define GC_mark_procs GC_arrays._mark_procs
1131 # define GC_heapsize GC_arrays._heapsize
1132 # define GC_max_heapsize GC_arrays._max_heapsize
1133 # define GC_words_allocd_before_gc GC_arrays._words_allocd_before_gc
1134 # define GC_heap_sects GC_arrays._heap_sects
1135 # define GC_last_stack GC_arrays._last_stack
1137 # define GC_heap_bases GC_arrays._heap_bases
1139 # define GC_static_roots GC_arrays._static_roots
1140 # define GC_root_index GC_arrays._root_index
1141 # define GC_excl_table GC_arrays._excl_table
1142 # define GC_all_nils GC_arrays._all_nils
1143 # define GC_top_index GC_arrays._top_index
1144 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
1145 # define GC_grungy_pages GC_arrays._grungy_pages
1147 # ifdef MPROTECT_VDB
1148 # define GC_dirty_pages GC_arrays._dirty_pages
1151 # define GC_written_pages GC_arrays._written_pages
1154 # define GC_composite_in_use GC_arrays._composite_in_use
1155 # define GC_atomic_in_use GC_arrays._atomic_in_use
1158 # define GC_size_map GC_arrays._size_map
1161 # define beginGC_arrays ((ptr_t)(&GC_arrays))
1162 # define endGC_arrays (((ptr_t)(&GC_arrays)) + (sizeof GC_arrays))
1165 # define MAXOBJKINDS 16
1167 extern struct obj_kind {
1168 ptr_t *ok_freelist; /* Array of free listheaders for this kind of object */
1169 /* Point either to GC_arrays or to storage allocated */
1170 /* with GC_scratch_alloc. */
1171 struct hblk **ok_reclaim_list;
1172 /* List headers for lists of blocks waiting to be */
1174 word ok_descriptor; /* Descriptor template for objects in this */
1176 GC_bool ok_relocate_descr;
1177 /* Add object size in bytes to descriptor */
1178 /* template to obtain descriptor. Otherwise */
1179 /* template is used as is. */
1180 GC_bool ok_init; /* Clear objects before putting them on the free list. */
1181 } GC_obj_kinds[MAXOBJKINDS];
1183 # define endGC_obj_kinds (((ptr_t)(&GC_obj_kinds)) + (sizeof GC_obj_kinds))
1185 # define end_gc_area ((ptr_t)endGC_arrays == (ptr_t)(&GC_obj_kinds) ? \
1186 endGC_obj_kinds : endGC_arrays)
1188 /* Predefined kinds: */
1191 # define UNCOLLECTABLE 2
1192 # ifdef ATOMIC_UNCOLLECTABLE
1193 # define AUNCOLLECTABLE 3
1195 # define IS_UNCOLLECTABLE(k) (((k) & ~1) == UNCOLLECTABLE)
1198 # define IS_UNCOLLECTABLE(k) ((k) == UNCOLLECTABLE)
1201 extern int GC_n_kinds;
1203 GC_API word GC_fo_entries;
1205 extern word GC_n_heap_sects; /* Number of separately added heap */
1208 extern word GC_page_size;
1211 extern word GC_n_heap_bases; /* See GC_heap_bases. */
1214 extern word GC_total_stack_black_listed;
1215 /* Number of bytes on stack blacklist. */
1217 extern word GC_black_list_spacing;
1218 /* Average number of bytes between blacklisted */
1219 /* blocks. Approximate. */
1220 /* Counts only blocks that are */
1221 /* "stack-blacklisted", i.e. that are */
1222 /* problematic in the interior of an object. */
1224 extern char * GC_invalid_map;
1225 /* Pointer to the nowhere valid hblk map */
1226 /* Blocks pointing to this map are free. */
1228 extern struct hblk * GC_hblkfreelist;
1229 /* List of completely empty heap blocks */
1230 /* Linked through hb_next field of */
1231 /* header structure associated with */
1234 extern GC_bool GC_is_initialized; /* GC_init() has been run. */
1236 extern GC_bool GC_objects_are_marked; /* There are marked objects in */
1239 #ifndef SMALL_CONFIG
1240 extern GC_bool GC_incremental;
1241 /* Using incremental/generational collection. */
1243 # define GC_incremental TRUE
1244 /* Hopefully allow optimizer to remove some code. */
1247 extern GC_bool GC_dirty_maintained;
1248 /* Dirty bits are being maintained, */
1249 /* either for incremental collection, */
1250 /* or to limit the root set. */
1253 extern ptr_t GC_stackbottom; /* Cool end of user stack */
1256 extern word GC_root_size; /* Total size of registered root sections */
1258 extern GC_bool GC_debugging_started; /* GC_debug_malloc has been called. */
1260 extern ptr_t GC_least_plausible_heap_addr;
1261 extern ptr_t GC_greatest_plausible_heap_addr;
1262 /* Bounds on the heap. Guaranteed valid */
1263 /* Likely to include future heap expansion. */
1267 # define abs(x) ((x) < 0? (-(x)) : (x))
1271 /* Marks are in a reserved area in */
1272 /* each heap block. Each word has one mark bit associated */
1273 /* with it. Only those corresponding to the beginning of an */
1274 /* object are used. */
1277 /* Mark bit operations */
1280 * Retrieve, set, clear the mark bit corresponding
1281 * to the nth word in a given heap block.
1283 * (Recall that bit n corresponds to object beginning at word n
1284 * relative to the beginning of the block, including unused words)
1287 # define mark_bit_from_hdr(hhdr,n) (((hhdr)->hb_marks[divWORDSZ(n)] \
1288 >> (modWORDSZ(n))) & (word)1)
1289 # define set_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1290 |= (word)1 << modWORDSZ(n)
1292 # define clear_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1293 &= ~((word)1 << modWORDSZ(n))
1295 /* Important internal collector routines */
1297 ptr_t GC_approx_sp();
1299 GC_bool GC_should_collect();
1300 #ifdef PRESERVE_LAST
1301 GC_bool GC_in_last_heap_sect(/* ptr_t */);
1302 /* In last added heap section? If so, avoid breaking up. */
1304 void GC_apply_to_all_blocks(/*fn, client_data*/);
1305 /* Invoke fn(hbp, client_data) for each */
1306 /* allocated heap block. */
1307 struct hblk * GC_next_block(/* struct hblk * h */);
1308 void GC_mark_init();
1309 void GC_clear_marks(); /* Clear mark bits for all heap objects. */
1310 void GC_invalidate_mark_state(); /* Tell the marker that marked */
1311 /* objects may point to unmarked */
1312 /* ones, and roots may point to */
1313 /* unmarked objects. */
1314 /* Reset mark stack. */
1315 void GC_mark_from_mark_stack(); /* Mark from everything on the mark stack. */
1316 /* Return after about one pages worth of */
1318 GC_bool GC_mark_stack_empty();
1319 GC_bool GC_mark_some(); /* Perform about one pages worth of marking */
1320 /* work of whatever kind is needed. Returns */
1321 /* quickly if no collection is in progress. */
1322 /* Return TRUE if mark phase finished. */
1323 void GC_initiate_gc(); /* initiate collection. */
1324 /* If the mark state is invalid, this */
1325 /* becomes full colleection. Otherwise */
1327 void GC_push_all(/*b,t*/); /* Push everything in a range */
1328 /* onto mark stack. */
1329 void GC_push_dirty(/*b,t*/); /* Push all possibly changed */
1330 /* subintervals of [b,t) onto */
1332 #ifndef SMALL_CONFIG
1333 void GC_push_conditional(/* ptr_t b, ptr_t t, GC_bool all*/);
1335 # define GC_push_conditional(b, t, all) GC_push_all(b, t)
1337 /* Do either of the above, depending */
1338 /* on the third arg. */
1339 void GC_push_all_stack(/*b,t*/); /* As above, but consider */
1340 /* interior pointers as valid */
1341 void GC_push_roots(/* GC_bool all */); /* Push all or dirty roots. */
1342 extern void (*GC_push_other_roots)();
1343 /* Push system or application specific roots */
1344 /* onto the mark stack. In some environments */
1345 /* (e.g. threads environments) this is */
1346 /* predfined to be non-zero. A client supplied */
1347 /* replacement should also call the original */
1349 extern void (*GC_start_call_back)(/* void */);
1350 /* Called at start of full collections. */
1351 /* Not called if 0. Called with allocation */
1354 void GC_push_regs(); /* Push register contents onto mark stack. */
1355 void GC_remark(); /* Mark from all marked objects. Used */
1356 /* only if we had to drop something. */
1357 # if defined(MSWIN32)
1358 void __cdecl GC_push_one();
1360 void GC_push_one(/*p*/); /* If p points to an object, mark it */
1361 /* and push contents on the mark stack */
1363 void GC_push_one_checked(/*p*/); /* Ditto, omits plausibility test */
1364 void GC_push_marked(/* struct hblk h, hdr * hhdr */);
1365 /* Push contents of all marked objects in h onto */
1368 # define GC_push_next_marked_dirty(h) GC_push_next_marked(h)
1370 struct hblk * GC_push_next_marked_dirty(/* h */);
1371 /* Invoke GC_push_marked on next dirty block above h. */
1372 /* Return a pointer just past the end of this block. */
1373 #endif /* !SMALL_CONFIG */
1374 struct hblk * GC_push_next_marked(/* h */);
1375 /* Ditto, but also mark from clean pages. */
1376 struct hblk * GC_push_next_marked_uncollectable(/* h */);
1377 /* Ditto, but mark only from uncollectable pages. */
1378 GC_bool GC_stopped_mark(); /* Stop world and mark from all roots */
1380 void GC_clear_hdr_marks(/* hhdr */); /* Clear the mark bits in a header */
1381 void GC_set_hdr_marks(/* hhdr */); /* Set the mark bits in a header */
1382 void GC_add_roots_inner();
1383 GC_bool GC_is_static_root(/* ptr_t p */);
1384 /* Is the address p in one of the registered static */
1385 /* root sections? */
1386 void GC_register_dynamic_libraries();
1387 /* Add dynamic library data sections to the root set. */
1389 /* Machine dependent startup routines */
1390 ptr_t GC_get_stack_base();
1391 void GC_register_data_segments();
1393 /* Black listing: */
1395 # ifndef ALL_INTERIOR_POINTERS
1396 void GC_add_to_black_list_normal(/* bits, maybe source */);
1397 /* Register bits as a possible future false */
1398 /* reference from the heap or static data */
1399 # ifdef PRINT_BLACK_LIST
1400 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1401 GC_add_to_black_list_normal(bits, source)
1403 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1404 GC_add_to_black_list_normal(bits)
1407 # ifdef PRINT_BLACK_LIST
1408 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1409 GC_add_to_black_list_stack(bits, source)
1411 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1412 GC_add_to_black_list_stack(bits)
1416 void GC_add_to_black_list_stack(/* bits, maybe source */);
1417 struct hblk * GC_is_black_listed(/* h, len */);
1418 /* If there are likely to be false references */
1419 /* to a block starting at h of the indicated */
1420 /* length, then return the next plausible */
1421 /* starting location for h that might avoid */
1422 /* these false references. */
1423 void GC_promote_black_lists();
1424 /* Declare an end to a black listing phase. */
1425 void GC_unpromote_black_lists();
1426 /* Approximately undo the effect of the above. */
1427 /* This actually loses some information, but */
1428 /* only in a reasonably safe way. */
1429 word GC_number_stack_black_listed(/*struct hblk *start, struct hblk *endp1 */);
1430 /* Return the number of (stack) blacklisted */
1431 /* blocks in the range for statistical */
1434 ptr_t GC_scratch_alloc(/*bytes*/);
1435 /* GC internal memory allocation for */
1436 /* small objects. Deallocation is not */
1439 /* Heap block layout maps: */
1440 void GC_invalidate_map(/* hdr */);
1441 /* Remove the object map associated */
1442 /* with the block. This identifies */
1443 /* the block as invalid to the mark */
1445 GC_bool GC_add_map_entry(/*sz*/);
1446 /* Add a heap block map for objects of */
1447 /* size sz to obj_map. */
1448 /* Return FALSE on failure. */
1449 void GC_register_displacement_inner(/*offset*/);
1450 /* Version of GC_register_displacement */
1451 /* that assumes lock is already held */
1452 /* and signals are already disabled. */
1454 /* hblk allocation: */
1455 void GC_new_hblk(/*size_in_words, kind*/);
1456 /* Allocate a new heap block, and build */
1457 /* a free list in it. */
1458 struct hblk * GC_allochblk(/*size_in_words, kind*/);
1459 /* Allocate a heap block, clear it if */
1460 /* for composite objects, inform */
1461 /* the marker that block is valid */
1462 /* for objects of indicated size. */
1463 /* sz < 0 ==> atomic. */
1464 void GC_freehblk(); /* Deallocate a heap block and mark it */
1468 void GC_init_inner();
1469 GC_bool GC_expand_hp_inner();
1470 void GC_start_reclaim(/*abort_if_found*/);
1471 /* Restore unmarked objects to free */
1472 /* lists, or (if abort_if_found is */
1473 /* TRUE) report them. */
1474 /* Sweeping of small object pages is */
1475 /* largely deferred. */
1476 void GC_continue_reclaim(/*size, kind*/);
1477 /* Sweep pages of the given size and */
1478 /* kind, as long as possible, and */
1479 /* as long as the corr. free list is */
1481 void GC_reclaim_or_delete_all();
1482 /* Arrange for all reclaim lists to be */
1483 /* empty. Judiciously choose between */
1484 /* sweeping and discarding each page. */
1485 GC_bool GC_reclaim_all(/* GC_stop_func f*/);
1486 /* Reclaim all blocks. Abort (in a */
1487 /* consistent state) if f returns TRUE. */
1488 GC_bool GC_block_empty(/* hhdr */); /* Block completely unmarked? */
1489 GC_bool GC_never_stop_func(); /* Returns FALSE. */
1490 GC_bool GC_try_to_collect_inner(/* GC_stop_func f */);
1491 /* Collect; caller must have acquired */
1492 /* lock and disabled signals. */
1493 /* Collection is aborted if f returns */
1494 /* TRUE. Returns TRUE if it completes */
1496 # define GC_gcollect_inner() \
1497 (void) GC_try_to_collect_inner(GC_never_stop_func)
1498 void GC_finish_collection(); /* Finish collection. Mark bits are */
1499 /* consistent and lock is still held. */
1500 GC_bool GC_collect_or_expand(/* needed_blocks */);
1501 /* Collect or expand heap in an attempt */
1502 /* make the indicated number of free */
1503 /* blocks available. Should be called */
1504 /* until the blocks are available or */
1505 /* until it fails by returning FALSE. */
1506 GC_API void GC_init(); /* Initialize collector. */
1507 void GC_collect_a_little_inner(/* int n */);
1508 /* Do n units worth of garbage */
1509 /* collection work, if appropriate. */
1510 /* A unit is an amount appropriate for */
1511 /* HBLKSIZE bytes of allocation. */
1512 ptr_t GC_generic_malloc(/* bytes, kind */);
1513 /* Allocate an object of the given */
1514 /* kind. By default, there are only */
1515 /* a few kinds: composite(pointerfree), */
1516 /* atomic, uncollectable, etc. */
1517 /* We claim it's possible for clever */
1518 /* client code that understands GC */
1519 /* internals to add more, e.g. to */
1520 /* communicate object layout info */
1521 /* to the collector. */
1522 ptr_t GC_generic_malloc_ignore_off_page(/* bytes, kind */);
1523 /* As above, but pointers past the */
1524 /* first page of the resulting object */
1526 ptr_t GC_generic_malloc_inner(/* bytes, kind */);
1527 /* Ditto, but I already hold lock, etc. */
1528 ptr_t GC_generic_malloc_words_small GC_PROTO((size_t words, int kind));
1529 /* As above, but size in units of words */
1530 /* Bypasses MERGE_SIZES. Assumes */
1531 /* words <= MAXOBJSZ. */
1532 ptr_t GC_generic_malloc_inner_ignore_off_page(/* bytes, kind */);
1533 /* Allocate an object, where */
1534 /* the client guarantees that there */
1535 /* will always be a pointer to the */
1536 /* beginning of the object while the */
1537 /* object is live. */
1538 ptr_t GC_allocobj(/* sz_inn_words, kind */);
1539 /* Make the indicated */
1540 /* free list nonempty, and return its */
1543 void GC_init_headers();
1544 GC_bool GC_install_header(/*h*/);
1545 /* Install a header for block h. */
1546 /* Return FALSE on failure. */
1547 GC_bool GC_install_counts(/*h, sz*/);
1548 /* Set up forwarding counts for block */
1550 /* Return FALSE on failure. */
1551 void GC_remove_header(/*h*/);
1552 /* Remove the header for block h. */
1553 void GC_remove_counts(/*h, sz*/);
1554 /* Remove forwarding counts for h. */
1555 hdr * GC_find_header(/*p*/); /* Debugging only. */
1557 void GC_finalize(); /* Perform all indicated finalization actions */
1558 /* on unmarked objects. */
1559 /* Unreachable finalizable objects are enqueued */
1560 /* for processing by GC_invoke_finalizers. */
1561 /* Invoked with lock. */
1563 void GC_add_to_heap(/*p, bytes*/);
1564 /* Add a HBLKSIZE aligned chunk to the heap. */
1566 void GC_print_obj(/* ptr_t p */);
1567 /* P points to somewhere inside an object with */
1568 /* debugging info. Print a human readable */
1569 /* description of the object to stderr. */
1570 extern void (*GC_check_heap)();
1571 /* Check that all objects in the heap with */
1572 /* debugging info are intact. Print */
1573 /* descriptions of any that are not. */
1574 extern void (*GC_print_heap_obj)(/* ptr_t p */);
1575 /* If possible print s followed by a more */
1576 /* detailed description of the object */
1577 /* referred to by p. */
1579 /* Virtual dirty bit implementation: */
1580 /* Each implementation exports the following: */
1581 void GC_read_dirty(); /* Retrieve dirty bits. */
1582 GC_bool GC_page_was_dirty(/* struct hblk * h */);
1583 /* Read retrieved dirty bits. */
1584 GC_bool GC_page_was_ever_dirty(/* struct hblk * h */);
1585 /* Could the page contain valid heap pointers? */
1586 void GC_is_fresh(/* struct hblk * h, word number_of_blocks */);
1587 /* Assert the region currently contains no */
1588 /* valid pointers. */
1589 void GC_write_hint(/* struct hblk * h */);
1590 /* h is about to be written. */
1591 void GC_dirty_init();
1593 /* Slow/general mark bit manipulation: */
1594 GC_API GC_bool GC_is_marked();
1595 void GC_clear_mark_bit();
1596 void GC_set_mark_bit();
1598 /* Stubborn objects: */
1599 void GC_read_changed(); /* Analogous to GC_read_dirty */
1600 GC_bool GC_page_was_changed(/* h */); /* Analogous to GC_page_was_dirty */
1601 void GC_clean_changing_list(); /* Collect obsolete changing list entries */
1602 void GC_stubborn_init();
1604 /* Debugging print routines: */
1605 void GC_print_block_list();
1606 void GC_print_hblkfreelist();
1607 void GC_print_heap_sects();
1608 void GC_print_static_roots();
1611 /* Make arguments appear live to compiler */
1613 void GC_noop(void*, ...);
1615 GC_API void GC_noop();
1618 void GC_noop1(/* word arg */);
1620 /* Logging and diagnostic output: */
1621 GC_API void GC_printf GC_PROTO((char * format, long, long, long, long, long, long));
1622 /* A version of printf that doesn't allocate, */
1623 /* is restricted to long arguments, and */
1624 /* (unfortunately) doesn't use varargs for */
1625 /* portability. Restricted to 6 args and */
1626 /* 1K total output length. */
1627 /* (We use sprintf. Hopefully that doesn't */
1628 /* allocate for long arguments.) */
1629 # define GC_printf0(f) GC_printf(f, 0l, 0l, 0l, 0l, 0l, 0l)
1630 # define GC_printf1(f,a) GC_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1631 # define GC_printf2(f,a,b) GC_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1632 # define GC_printf3(f,a,b,c) GC_printf(f, (long)a, (long)b, (long)c, 0l, 0l, 0l)
1633 # define GC_printf4(f,a,b,c,d) GC_printf(f, (long)a, (long)b, (long)c, \
1635 # define GC_printf5(f,a,b,c,d,e) GC_printf(f, (long)a, (long)b, (long)c, \
1636 (long)d, (long)e, 0l)
1637 # define GC_printf6(f,a,b,c,d,e,g) GC_printf(f, (long)a, (long)b, (long)c, \
1638 (long)d, (long)e, (long)g)
1640 void GC_err_printf(/* format, a, b, c, d, e, f */);
1641 # define GC_err_printf0(f) GC_err_puts(f)
1642 # define GC_err_printf1(f,a) GC_err_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1643 # define GC_err_printf2(f,a,b) GC_err_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1644 # define GC_err_printf3(f,a,b,c) GC_err_printf(f, (long)a, (long)b, (long)c, \
1646 # define GC_err_printf4(f,a,b,c,d) GC_err_printf(f, (long)a, (long)b, \
1647 (long)c, (long)d, 0l, 0l)
1648 # define GC_err_printf5(f,a,b,c,d,e) GC_err_printf(f, (long)a, (long)b, \
1651 # define GC_err_printf6(f,a,b,c,d,e,g) GC_err_printf(f, (long)a, (long)b, \
1654 /* Ditto, writes to stderr. */
1656 void GC_err_puts(/* char *s */);
1657 /* Write s to stderr, don't buffer, don't add */
1658 /* newlines, don't ... */
1661 # endif /* GC_PRIVATE_H */
projects / fw / sdcc / blob