2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1994 by Xerox Corporation. All rights reserved.
4 * Copyright (c) 1996-1999 by Silicon Graphics. All rights reserved.
5 * Copyright (c) 1999-2004 Hewlett-Packard Development Company, L.P.
8 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
9 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
11 * Permission is hereby granted to use or copy this program
12 * for any purpose, provided the above notices are retained on all copies.
13 * Permission to modify the code and to distribute modified code is granted,
14 * provided the above notices are retained, and a notice that the code was
15 * modified is included with the above copyright notice.
23 # if !(defined( sony_news ) )
28 # include <sys/types.h>
29 # include <sys/time.h>
30 # include <sys/resource.h>
34 # include <sys/types.h>
35 # include <sys/time.h>
36 # include <sys/resource.h>
40 # define AO_REQUIRE_CAS
48 # include "../gc_tiny_fl.h"
52 # include "../gc_mark.h"
56 typedef GC_signed_word signed_word;
57 typedef unsigned int unsigned32;
63 typedef char * ptr_t; /* A generic pointer to which we can add */
64 /* byte displacements and which can be used */
65 /* for address comparisons. */
68 # include "gcconfig.h"
76 # define EXPECT(expr, outcome) __builtin_expect(expr,outcome)
77 /* Equivalent to (expr), but predict that usually (expr)==outcome. */
78 # define INLINE inline
80 # define EXPECT(expr, outcome) (expr)
85 # include "gc_locks.h"
88 # ifdef STACK_GROWS_DOWN
89 # define COOLER_THAN >
90 # define HOTTER_THAN <
91 # define MAKE_COOLER(x,y) if ((x)+(y) > (x)) {(x) += (y);} \
92 else {(x) = (ptr_t)ONES;}
93 # define MAKE_HOTTER(x,y) (x) -= (y)
95 # define COOLER_THAN <
96 # define HOTTER_THAN >
97 # define MAKE_COOLER(x,y) if ((x)-(y) < (x)) {(x) -= (y);} else {(x) = 0;}
98 # define MAKE_HOTTER(x,y) (x) += (y)
101 #if defined(AMIGA) && defined(__SASC)
102 # define GC_FAR __far
108 /*********************************/
110 /* Definitions for conservative */
113 /*********************************/
115 /*********************************/
117 /* Easily changeable parameters */
119 /*********************************/
121 /* #define STUBBORN_ALLOC */
122 /* Enable stubborm allocation, and thus a limited */
123 /* form of incremental collection w/o dirty bits. */
125 /* #define ALL_INTERIOR_POINTERS */
126 /* Forces all pointers into the interior of an */
127 /* object to be considered valid. Also causes the */
128 /* sizes of all objects to be inflated by at least */
129 /* one byte. This should suffice to guarantee */
130 /* that in the presence of a compiler that does */
131 /* not perform garbage-collector-unsafe */
132 /* optimizations, all portable, strictly ANSI */
133 /* conforming C programs should be safely usable */
134 /* with malloc replaced by GC_malloc and free */
135 /* calls removed. There are several disadvantages: */
136 /* 1. There are probably no interesting, portable, */
137 /* strictly ANSI conforming C programs. */
138 /* 2. This option makes it hard for the collector */
139 /* to allocate space that is not ``pointed to'' */
140 /* by integers, etc. Under SunOS 4.X with a */
141 /* statically linked libc, we empiricaly */
142 /* observed that it would be difficult to */
143 /* allocate individual objects larger than 100K. */
144 /* Even if only smaller objects are allocated, */
145 /* more swap space is likely to be needed. */
146 /* Fortunately, much of this will never be */
148 /* If you can easily avoid using this option, do. */
149 /* If not, try to keep individual objects small. */
150 /* This is now really controlled at startup, */
151 /* through GC_all_interior_pointers. */
154 #define GC_INVOKE_FINALIZERS() GC_notify_or_invoke_finalizers()
156 #if !defined(DONT_ADD_BYTE_AT_END)
157 # define EXTRA_BYTES GC_all_interior_pointers
158 # define MAX_EXTRA_BYTES 1
160 # define EXTRA_BYTES 0
161 # define MAX_EXTRA_BYTES 0
165 # ifndef LARGE_CONFIG
166 # define MINHINCR 16 /* Minimum heap increment, in blocks of HBLKSIZE */
167 /* Must be multiple of largest page size. */
168 # define MAXHINCR 2048 /* Maximum heap increment, in blocks */
171 # define MAXHINCR 4096
174 # define TIME_LIMIT 50 /* We try to keep pause times from exceeding */
175 /* this by much. In milliseconds. */
177 # define BL_LIMIT GC_black_list_spacing
178 /* If we need a block of N bytes, and we have */
179 /* a block of N + BL_LIMIT bytes available, */
180 /* and N > BL_LIMIT, */
181 /* but all possible positions in it are */
182 /* blacklisted, we just use it anyway (and */
183 /* print a warning, if warnings are enabled). */
184 /* This risks subsequently leaking the block */
185 /* due to a false reference. But not using */
186 /* the block risks unreasonable immediate */
189 /*********************************/
191 /* Stack saving for debugging */
193 /*********************************/
197 word ci_pc; /* Caller, not callee, pc */
199 word ci_arg[NARGS]; /* bit-wise complement to avoid retention */
201 # if (NFRAMES * (NARGS + 1)) % 2 == 1
202 /* Likely alignment problem. */
208 #ifdef SAVE_CALL_CHAIN
210 /* Fill in the pc and argument information for up to NFRAMES of my */
211 /* callers. Ignore my frame and my callers frame. */
212 void GC_save_callers(struct callinfo info[NFRAMES]);
214 void GC_print_callers(struct callinfo info[NFRAMES]);
219 /*********************************/
221 /* OS interface routines */
223 /*********************************/
229 # define CLOCK_TYPE struct timeval
230 # define GET_TIME(x) { struct rusage rusage; \
231 getrusage (RUSAGE_SELF, &rusage); \
232 x = rusage.ru_utime; }
233 # define MS_TIME_DIFF(a,b) ((double) (a.tv_sec - b.tv_sec) * 1000.0 \
234 + (double) (a.tv_usec - b.tv_usec) / 1000.0)
235 #else /* !BSD_TIME */
236 # if defined(MSWIN32) || defined(MSWINCE)
237 # include <windows.h>
238 # include <winbase.h>
239 # define CLOCK_TYPE DWORD
240 # define GET_TIME(x) x = GetTickCount()
241 # define MS_TIME_DIFF(a,b) ((long)((a)-(b)))
242 # else /* !MSWIN32, !MSWINCE, !BSD_TIME */
244 # if !defined(__STDC__) && defined(SPARC) && defined(SUNOS4)
245 clock_t clock(); /* Not in time.h, where it belongs */
247 # if defined(FREEBSD) && !defined(CLOCKS_PER_SEC)
248 # include <machine/limits.h>
249 # define CLOCKS_PER_SEC CLK_TCK
251 # if !defined(CLOCKS_PER_SEC)
252 # define CLOCKS_PER_SEC 1000000
254 * This is technically a bug in the implementation. ANSI requires that
255 * CLOCKS_PER_SEC be defined. But at least under SunOS4.1.1, it isn't.
256 * Also note that the combination of ANSI C and POSIX is incredibly gross
257 * here. The type clock_t is used by both clock() and times(). But on
258 * some machines these use different notions of a clock tick, CLOCKS_PER_SEC
259 * seems to apply only to clock. Hence we use it here. On many machines,
260 * including SunOS, clock actually uses units of microseconds (which are
261 * not really clock ticks).
264 # define CLOCK_TYPE clock_t
265 # define GET_TIME(x) x = clock()
266 # define MS_TIME_DIFF(a,b) ((unsigned long) \
267 (1000.0*(double)((a)-(b))/(double)CLOCKS_PER_SEC))
268 # endif /* !MSWIN32 */
269 #endif /* !BSD_TIME */
271 /* We use bzero and bcopy internally. They may not be available. */
272 # if defined(SPARC) && defined(SUNOS4)
273 # define BCOPY_EXISTS
275 # if defined(M68K) && defined(AMIGA)
276 # define BCOPY_EXISTS
278 # if defined(M68K) && defined(NEXT)
279 # define BCOPY_EXISTS
282 # define BCOPY_EXISTS
286 # define BCOPY_EXISTS
290 # define BCOPY_EXISTS
293 # ifndef BCOPY_EXISTS
295 # define BCOPY(x,y,n) memcpy(y, x, (size_t)(n))
296 # define BZERO(x,n) memset(x, 0, (size_t)(n))
298 # define BCOPY(x,y,n) bcopy((void *)(x),(void *)(y),(size_t)(n))
299 # define BZERO(x,n) bzero((void *)(x),(size_t)(n))
303 * Stop and restart mutator threads.
306 # include "th/PCR_ThCtl.h"
307 # define STOP_WORLD() \
308 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_stopNormal, \
309 PCR_allSigsBlocked, \
311 # define START_WORLD() \
312 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_null, \
313 PCR_allSigsBlocked, \
316 # if defined(GC_SOLARIS_THREADS) || defined(GC_WIN32_THREADS) \
317 || defined(GC_PTHREADS)
318 void GC_stop_world();
319 void GC_start_world();
320 # define STOP_WORLD() GC_stop_world()
321 # define START_WORLD() GC_start_world()
323 # define STOP_WORLD()
324 # define START_WORLD()
330 # define ABORT(s) PCR_Base_Panic(s)
333 # define ABORT(msg) abort()
335 GC_API void GC_abort(const char * msg);
336 # define ABORT(msg) GC_abort(msg)
340 /* Exit abnormally, but without making a mess (e.g. out of memory) */
342 # define EXIT() PCR_Base_Exit(1,PCR_waitForever)
344 # define EXIT() (void)exit(1)
347 /* Print warning message, e.g. almost out of memory. */
348 # define WARN(msg,arg) (*GC_current_warn_proc)("GC Warning: " msg, (GC_word)(arg))
349 extern GC_warn_proc GC_current_warn_proc;
351 /* Get environment entry */
352 #if !defined(NO_GETENV)
353 # if defined(EMPTY_GETENV_RESULTS)
354 /* Workaround for a reputed Wine bug. */
355 static inline char * fixed_getenv(const char *name)
357 char * tmp = getenv(name);
358 if (tmp == 0 || strlen(tmp) == 0)
362 # define GETENV(name) fixed_getenv(name)
364 # define GETENV(name) getenv(name)
367 # define GETENV(name) 0
371 # if defined(POWERPC)
372 # if CPP_WORDSZ == 32
373 # define GC_THREAD_STATE_T ppc_thread_state_t
374 # define GC_MACH_THREAD_STATE PPC_THREAD_STATE
375 # define GC_MACH_THREAD_STATE_COUNT PPC_THREAD_STATE_COUNT
376 # define GC_MACH_HEADER mach_header
377 # define GC_MACH_SECTION section
378 # define GC_GETSECTBYNAME getsectbynamefromheader
380 # define GC_THREAD_STATE_T ppc_thread_state64_t
381 # define GC_MACH_THREAD_STATE PPC_THREAD_STATE64
382 # define GC_MACH_THREAD_STATE_COUNT PPC_THREAD_STATE64_COUNT
383 # define GC_MACH_HEADER mach_header_64
384 # define GC_MACH_SECTION section_64
385 # define GC_GETSECTBYNAME getsectbynamefromheader_64
387 # elif defined(I386) || defined(X86_64)
388 # if CPP_WORDSZ == 32
389 # define GC_THREAD_STATE_T x86_thread_state32_t
390 # define GC_MACH_THREAD_STATE x86_THREAD_STATE32
391 # define GC_MACH_THREAD_STATE_COUNT x86_THREAD_STATE32_COUNT
392 # define GC_MACH_HEADER mach_header
393 # define GC_MACH_SECTION section
394 # define GC_GETSECTBYNAME getsectbynamefromheader
396 # define GC_THREAD_STATE_T x86_thread_state64_t
397 # define GC_MACH_THREAD_STATE x86_THREAD_STATE64
398 # define GC_MACH_THREAD_STATE_COUNT x86_THREAD_STATE64_COUNT
399 # define GC_MACH_HEADER mach_header_64
400 # define GC_MACH_SECTION section_64
401 # define GC_GETSECTBYNAME getsectbynamefromheader_64
404 # error define GC_THREAD_STATE_T
405 # define GC_MACH_THREAD_STATE MACHINE_THREAD_STATE
406 # define GC_MACH_THREAD_STATE_COUNT MACHINE_THREAD_STATE_COUNT
408 /* Try to work out the right way to access thread state structure members.
409 The structure has changed its definition in different Darwin versions.
410 This now defaults to the (older) names without __, thus hopefully,
411 not breaking any existing Makefile.direct builds. */
412 # if defined (HAS_PPC_THREAD_STATE___R0) \
413 || defined (HAS_PPC_THREAD_STATE64___R0) \
414 || defined (HAS_X86_THREAD_STATE32___EAX) \
415 || defined (HAS_X86_THREAD_STATE64___RAX)
416 # define THREAD_FLD(x) __ ## x
418 # define THREAD_FLD(x) x
422 /*********************************/
424 /* Word-size-dependent defines */
426 /*********************************/
429 # define WORDS_TO_BYTES(x) ((x)<<2)
430 # define BYTES_TO_WORDS(x) ((x)>>2)
431 # define LOGWL ((word)5) /* log[2] of CPP_WORDSZ */
432 # define modWORDSZ(n) ((n) & 0x1f) /* n mod size of word */
439 # define WORDS_TO_BYTES(x) ((x)<<3)
440 # define BYTES_TO_WORDS(x) ((x)>>3)
441 # define LOGWL ((word)6) /* log[2] of CPP_WORDSZ */
442 # define modWORDSZ(n) ((n) & 0x3f) /* n mod size of word */
448 /* The first TINY_FREELISTS free lists correspond to the first */
449 /* TINY_FREELISTS multiples of GRANULE_BYTES, i.e. we keep */
450 /* separate free lists for each multiple of GRANULE_BYTES */
451 /* up to (TINY_FREELISTS-1) * GRANULE_BYTES. After that they */
452 /* may be spread out further. */
453 #include "../gc_tiny_fl.h"
454 #define GRANULE_BYTES GC_GRANULE_BYTES
455 #define TINY_FREELISTS GC_TINY_FREELISTS
457 #define WORDSZ ((word)CPP_WORDSZ)
458 #define SIGNB ((word)1 << (WORDSZ-1))
459 #define BYTES_PER_WORD ((word)(sizeof (word)))
460 #define ONES ((word)(signed_word)(-1))
461 #define divWORDSZ(n) ((n) >> LOGWL) /* divide n by size of word */
463 #if GRANULE_BYTES == 8
464 # define BYTES_TO_GRANULES(n) ((n)>>3)
465 # define GRANULES_TO_BYTES(n) ((n)<<3)
466 # if CPP_WORDSZ == 64
467 # define GRANULES_TO_WORDS(n) (n)
468 # elif CPP_WORDSZ == 32
469 # define GRANULES_TO_WORDS(n) ((n)<<1)
471 # define GRANULES_TO_WORDS(n) BYTES_TO_WORDS(GRANULES_TO_BYTES(n))
473 #elif GRANULE_BYTES == 16
474 # define BYTES_TO_GRANULES(n) ((n)>>4)
475 # define GRANULES_TO_BYTES(n) ((n)<<4)
476 # if CPP_WORDSZ == 64
477 # define GRANULES_TO_WORDS(n) ((n)<<1)
478 # elif CPP_WORDSZ == 32
479 # define GRANULES_TO_WORDS(n) ((n)<<2)
481 # define GRANULES_TO_WORDS(n) BYTES_TO_WORDS(GRANULES_TO_BYTES(n))
484 # error Bad GRANULE_BYTES value
487 /*********************/
489 /* Size Parameters */
491 /*********************/
493 /* Heap block size, bytes. Should be power of 2. */
494 /* Incremental GC with MPROTECT_VDB currently requires the */
495 /* page size to be a multiple of HBLKSIZE. Since most modern */
496 /* architectures support variable page sizes down to 4K, and */
497 /* X86 is generally 4K, we now default to 4K, except for */
498 /* Alpha: Seems to be used with 8K pages. */
499 /* SMALL_CONFIG: Want less block-level fragmentation. */
503 # define CPP_LOG_HBLKSIZE 10
506 # define CPP_LOG_HBLKSIZE 13
508 # define CPP_LOG_HBLKSIZE 12
513 # define CPP_LOG_HBLKSIZE 9
515 # if HBLKSIZE == 1024
516 # define CPP_LOG_HBLKSIZE 10
518 # if HBLKSIZE == 2048
519 # define CPP_LOG_HBLKSIZE 11
521 # if HBLKSIZE == 4096
522 # define CPP_LOG_HBLKSIZE 12
524 # if HBLKSIZE == 8192
525 # define CPP_LOG_HBLKSIZE 13
527 # if HBLKSIZE == 16384
528 # define CPP_LOG_HBLKSIZE 14
530 # ifndef CPP_LOG_HBLKSIZE
536 # define CPP_HBLKSIZE (1 << CPP_LOG_HBLKSIZE)
537 # define LOG_HBLKSIZE ((size_t)CPP_LOG_HBLKSIZE)
538 # define HBLKSIZE ((size_t)CPP_HBLKSIZE)
541 /* max size objects supported by freelist (larger objects are */
542 /* allocated directly with allchblk(), by rounding to the next */
543 /* multiple of HBLKSIZE. */
545 #define CPP_MAXOBJBYTES (CPP_HBLKSIZE/2)
546 #define MAXOBJBYTES ((size_t)CPP_MAXOBJBYTES)
547 #define CPP_MAXOBJWORDS BYTES_TO_WORDS(CPP_MAXOBJBYTES)
548 #define MAXOBJWORDS ((size_t)CPP_MAXOBJWORDS)
549 #define CPP_MAXOBJGRANULES BYTES_TO_GRANULES(CPP_MAXOBJBYTES)
550 #define MAXOBJGRANULES ((size_t)CPP_MAXOBJGRANULES)
552 # define divHBLKSZ(n) ((n) >> LOG_HBLKSIZE)
554 # define HBLK_PTR_DIFF(p,q) divHBLKSZ((ptr_t)p - (ptr_t)q)
555 /* Equivalent to subtracting 2 hblk pointers. */
556 /* We do it this way because a compiler should */
557 /* find it hard to use an integer division */
558 /* instead of a shift. The bundled SunOS 4.1 */
559 /* o.w. sometimes pessimizes the subtraction to */
560 /* involve a call to .div. */
562 # define modHBLKSZ(n) ((n) & (HBLKSIZE-1))
564 # define HBLKPTR(objptr) ((struct hblk *)(((word) (objptr)) & ~(HBLKSIZE-1)))
566 # define HBLKDISPL(objptr) (((size_t) (objptr)) & (HBLKSIZE-1))
568 /* Round up byte allocation requests to integral number of words, etc. */
569 # define ROUNDED_UP_WORDS(n) \
570 BYTES_TO_WORDS((n) + (WORDS_TO_BYTES(1) - 1 + EXTRA_BYTES))
571 # define ROUNDED_UP_GRANULES(n) \
572 BYTES_TO_GRANULES((n) + (GRANULE_BYTES - 1 + EXTRA_BYTES))
573 # if MAX_EXTRA_BYTES == 0
574 # define SMALL_OBJ(bytes) EXPECT((bytes) <= (MAXOBJBYTES), 1)
576 # define SMALL_OBJ(bytes) \
577 (EXPECT((bytes) <= (MAXOBJBYTES - MAX_EXTRA_BYTES), 1) || \
578 (bytes) <= (MAXOBJBYTES - EXTRA_BYTES))
579 /* This really just tests bytes <= MAXOBJBYTES - EXTRA_BYTES. */
580 /* But we try to avoid looking up EXTRA_BYTES. */
582 # define ADD_SLOP(bytes) ((bytes) + EXTRA_BYTES)
584 # define MIN_WORDS 2 /* FIXME: obsolete */
589 * Hash table representation of sets of pages.
590 * Implements a map from aligned HBLKSIZE chunks of the address space to one
592 * This assumes it is OK to spuriously set bits, e.g. because multiple
593 * addresses are represented by a single location.
594 * Used by black-listing code, and perhaps by dirty bit maintenance code.
598 # if CPP_WORDSZ == 32
599 # define LOG_PHT_ENTRIES 20 /* Collisions likely at 1M blocks, */
600 /* which is >= 4GB. Each table takes */
601 /* 128KB, some of which may never be */
604 # define LOG_PHT_ENTRIES 21 /* Collisions likely at 2M blocks, */
605 /* which is >= 8GB. Each table takes */
606 /* 256KB, some of which may never be */
611 # define LOG_PHT_ENTRIES 15 /* Collisions are likely if heap grows */
612 /* to more than 32K hblks = 128MB. */
613 /* Each hash table occupies 4K bytes. */
614 # else /* default "medium" configuration */
615 # define LOG_PHT_ENTRIES 18 /* Collisions are likely if heap grows */
616 /* to more than 256K hblks >= 1GB. */
617 /* Each hash table occupies 32K bytes. */
618 /* Even for somewhat smaller heaps, */
619 /* say half that, collisions may be an */
620 /* issue because we blacklist */
621 /* addresses outside the heap. */
624 # define PHT_ENTRIES ((word)1 << LOG_PHT_ENTRIES)
625 # define PHT_SIZE (PHT_ENTRIES >> LOGWL)
626 typedef word page_hash_table[PHT_SIZE];
628 # define PHT_HASH(addr) ((((word)(addr)) >> LOG_HBLKSIZE) & (PHT_ENTRIES - 1))
630 # define get_pht_entry_from_index(bl, index) \
631 (((bl)[divWORDSZ(index)] >> modWORDSZ(index)) & 1)
632 # define set_pht_entry_from_index(bl, index) \
633 (bl)[divWORDSZ(index)] |= (word)1 << modWORDSZ(index)
634 # define clear_pht_entry_from_index(bl, index) \
635 (bl)[divWORDSZ(index)] &= ~((word)1 << modWORDSZ(index))
636 /* And a dumb but thread-safe version of set_pht_entry_from_index. */
637 /* This sets (many) extra bits. */
638 # define set_pht_entry_from_index_safe(bl, index) \
639 (bl)[divWORDSZ(index)] = ONES
643 /********************************************/
645 /* H e a p B l o c k s */
647 /********************************************/
649 /* heap block header */
650 #define HBLKMASK (HBLKSIZE-1)
652 #define MARK_BITS_PER_HBLK (HBLKSIZE/GRANULE_BYTES)
654 /* We allocate 1 bit per allocation granule. */
655 /* If MARK_BIT_PER_GRANULE is defined, we use */
656 /* every nth bit, where n is the number of */
657 /* allocation granules per object. If */
658 /* MARK_BIT_PER_OBJ is defined, we only use the */
659 /* initial group of mark bits, and it is safe */
660 /* to allocate smaller header for large objects. */
662 # ifdef USE_MARK_BYTES
663 # define MARK_BITS_SZ (MARK_BITS_PER_HBLK + 1)
664 /* Unlike the other case, this is in units of bytes. */
665 /* Since we force doubleword alignment, we need at most one */
666 /* mark bit per 2 words. But we do allocate and set one */
667 /* extra mark bit to avoid an explicit check for the */
668 /* partial object at the end of each block. */
670 # define MARK_BITS_SZ (MARK_BITS_PER_HBLK/CPP_WORDSZ + 1)
674 # include <atomic_ops.h>
675 typedef AO_t counter_t;
677 typedef size_t counter_t;
680 /* We maintain layout maps for heap blocks containing objects of a given */
681 /* size. Each entry in this map describes a byte offset and has the */
682 /* following type. */
684 struct hblk * hb_next; /* Link field for hblk free list */
685 /* and for lists of chunks waiting to be */
687 struct hblk * hb_prev; /* Backwards link for free list. */
688 struct hblk * hb_block; /* The corresponding block. */
689 unsigned char hb_obj_kind;
690 /* Kind of objects in the block. Each kind */
691 /* identifies a mark procedure and a set of */
692 /* list headers. Sometimes called regions. */
693 unsigned char hb_flags;
694 # define IGNORE_OFF_PAGE 1 /* Ignore pointers that do not */
695 /* point to the first page of */
697 # define WAS_UNMAPPED 2 /* This is a free block, which has */
698 /* been unmapped from the address */
700 /* GC_remap must be invoked on it */
701 /* before it can be reallocated. */
702 /* Only set with USE_MUNMAP. */
703 # define FREE_BLK 4 /* Block is free, i.e. not in use. */
704 unsigned short hb_last_reclaimed;
705 /* Value of GC_gc_no when block was */
706 /* last allocated or swept. May wrap. */
707 /* For a free block, this is maintained */
708 /* only for USE_MUNMAP, and indicates */
709 /* when the header was allocated, or */
710 /* when the size of the block last */
712 size_t hb_sz; /* If in use, size in bytes, of objects in the block. */
713 /* if free, the size in bytes of the whole block */
714 /* We assume that this is convertible to signed_word */
715 /* without generating a negative result. We avoid */
716 /* generating free blocks larger than that. */
717 word hb_descr; /* object descriptor for marking. See */
719 # ifdef MARK_BIT_PER_OBJ
720 unsigned32 hb_inv_sz; /* A good upper bound for 2**32/hb_sz. */
721 /* For large objects, we use */
723 # define LARGE_INV_SZ (1 << 16)
725 unsigned char hb_large_block;
726 short * hb_map; /* Essentially a table of remainders */
727 /* mod BYTES_TO_GRANULES(hb_sz), except */
728 /* for large blocks. See GC_obj_map. */
730 counter_t hb_n_marks; /* Number of set mark bits, excluding */
731 /* the one always set at the end. */
732 /* Currently it is concurrently */
733 /* updated and hence only approximate. */
734 /* But a zero value does guarantee that */
735 /* the block contains no marked */
737 /* Ensuring this property means that we */
738 /* never decrement it to zero during a */
739 /* collection, and hence the count may */
740 /* be one too high. Due to concurrent */
741 /* updates, an arbitrary number of */
742 /* increments, but not all of them (!) */
743 /* may be lost, hence it may in theory */
744 /* be much too low. */
745 /* The count may also be too high if */
746 /* multiple mark threads mark the */
747 /* same object due to a race. */
748 /* Without parallel marking, the count */
750 # ifdef USE_MARK_BYTES
752 char _hb_marks[MARK_BITS_SZ];
753 /* The i'th byte is 1 if the object */
754 /* starting at granule i or object i is */
756 /* The mark bit for the "one past the */
757 /* end" object is always set to avoid a */
758 /* special case test in the marker. */
759 word dummy; /* Force word alignment of mark bytes. */
761 # define hb_marks _mark_byte_union._hb_marks
763 word hb_marks[MARK_BITS_SZ];
764 # endif /* !USE_MARK_BYTES */
767 # define ANY_INDEX 23 /* "Random" mark bit index for assertions */
769 /* heap block body */
771 # define HBLK_WORDS (HBLKSIZE/sizeof(word))
772 # define HBLK_GRANULES (HBLKSIZE/GRANULE_BYTES)
774 /* The number of objects in a block dedicated to a certain size. */
775 /* may erroneously yield zero (instead of one) for large objects. */
776 # define HBLK_OBJS(sz_in_bytes) (HBLKSIZE/(sz_in_bytes))
779 char hb_body[HBLKSIZE];
782 # define HBLK_IS_FREE(hdr) (((hdr) -> hb_flags & FREE_BLK) != 0)
784 # define OBJ_SZ_TO_BLOCKS(sz) divHBLKSZ(sz + HBLKSIZE-1)
785 /* Size of block (in units of HBLKSIZE) needed to hold objects of */
786 /* given sz (in bytes). */
788 /* Object free list link */
789 # define obj_link(p) (*(void **)(p))
791 # define LOG_MAX_MARK_PROCS 6
792 # define MAX_MARK_PROCS (1 << LOG_MAX_MARK_PROCS)
794 /* Root sets. Logically private to mark_rts.c. But we don't want the */
795 /* tables scanned, so we put them here. */
796 /* MAX_ROOT_SETS is the maximum number of ranges that can be */
797 /* registered as static roots. */
799 # define MAX_ROOT_SETS 8192
802 # define MAX_ROOT_SETS 512
804 # define MAX_ROOT_SETS 2048
808 # define MAX_EXCLUSIONS (MAX_ROOT_SETS/4)
809 /* Maximum number of segments that can be excluded from root sets. */
812 * Data structure for excluded static roots.
819 /* Data structure for list of root sets. */
820 /* We keep a hash table, so that we can filter out duplicate additions. */
821 /* Under Win32, we need to do a better job of filtering overlaps, so */
822 /* we resort to sequential search, and pay the price. */
826 # if !defined(MSWIN32) && !defined(MSWINCE)
827 struct roots * r_next;
830 /* Delete before registering new dynamic libraries */
833 #if !defined(MSWIN32) && !defined(MSWINCE)
834 /* Size of hash table index to roots. */
835 # define LOG_RT_SIZE 6
836 # define RT_SIZE (1 << LOG_RT_SIZE) /* Power of 2, may be != MAX_ROOT_SETS */
839 /* Lists of all heap blocks and free lists */
840 /* as well as other random data structures */
841 /* that should not be scanned by the */
843 /* These are grouped together in a struct */
844 /* so that they can be easily skipped by the */
845 /* GC_mark routine. */
846 /* The ordering is weird to make GC_malloc */
847 /* faster by keeping the important fields */
848 /* sufficiently close together that a */
849 /* single load of a base register will do. */
850 /* Scalars that could easily appear to */
851 /* be pointers are also put here. */
852 /* The main fields should precede any */
853 /* conditionally included fields, so that */
854 /* gc_inl.h will work even if a different set */
855 /* of macros is defined when the client is */
859 word _heapsize; /* Heap size in bytes. */
861 word _requested_heapsize; /* Heap size due to explicit expansion */
862 ptr_t _last_heap_addr;
863 ptr_t _prev_heap_addr;
864 word _large_free_bytes;
865 /* Total bytes contained in blocks on large object free */
867 word _large_allocd_bytes;
868 /* Total number of bytes in allocated large objects blocks. */
869 /* For the purposes of this counter and the next one only, a */
870 /* large object is one that occupies a block of at least */
872 word _max_large_allocd_bytes;
873 /* Maximum number of bytes that were ever allocated in */
874 /* large object blocks. This is used to help decide when it */
875 /* is safe to split up a large block. */
876 word _bytes_allocd_before_gc;
877 /* Number of words allocated before this */
878 /* collection cycle. */
879 # ifndef SEPARATE_GLOBALS
881 /* Number of words allocated during this collection cycle */
884 /* Number of black-listed bytes dropped during GC cycle */
885 /* as a result of repeated scanning during allocation */
886 /* attempts. These are treated largely as allocated, */
887 /* even though they are not useful to the client. */
888 word _bytes_finalized;
889 /* Approximate number of bytes in objects (and headers) */
890 /* That became ready for finalization in the last */
892 word _non_gc_bytes_at_gc;
893 /* Number of explicitly managed bytes of storage */
894 /* at last collection. */
896 /* Number of explicitly deallocated bytes of memory */
897 /* since last collection. */
898 word _finalizer_bytes_freed;
899 /* Bytes of memory explicitly deallocated while */
900 /* finalizers were running. Used to approximate mem. */
901 /* explicitly deallocated by finalizers. */
902 ptr_t _scratch_end_ptr;
903 ptr_t _scratch_last_end_ptr;
904 /* Used by headers.c, and can easily appear to point to */
906 GC_mark_proc _mark_procs[MAX_MARK_PROCS];
907 /* Table of user-defined mark procedures. There is */
908 /* a small number of these, which can be referenced */
909 /* by DS_PROC mark descriptors. See gc_mark.h. */
911 # ifndef SEPARATE_GLOBALS
912 void *_objfreelist[MAXOBJGRANULES+1];
913 /* free list for objects */
914 void *_aobjfreelist[MAXOBJGRANULES+1];
915 /* free list for atomic objs */
918 void *_uobjfreelist[MAXOBJGRANULES+1];
919 /* uncollectable but traced objs */
920 /* objects on this and auobjfreelist */
921 /* are always marked, except during */
922 /* garbage collections. */
923 # ifdef ATOMIC_UNCOLLECTABLE
924 void *_auobjfreelist[MAXOBJGRANULES+1];
926 /* uncollectable but traced objs */
928 word _composite_in_use;
929 /* Number of words in accessible composite */
932 /* Number of words in accessible atomic */
935 word _unmapped_bytes;
938 size_t _size_map[MAXOBJBYTES+1];
939 /* Number of words to allocate for a given allocation request in */
942 # ifdef STUBBORN_ALLOC
943 ptr_t _sobjfreelist[MAXOBJGRANULES+1];
945 /* free list for immutable objects */
946 # ifdef MARK_BIT_PER_GRANULE
947 short * _obj_map[MAXOBJGRANULES+1];
948 /* If not NIL, then a pointer to a map of valid */
949 /* object addresses. */
950 /* _obj_map[sz_in_granules][i] is */
951 /* i % sz_in_granules. */
952 /* This is now used purely to replace a */
953 /* division in the marker by a table lookup. */
954 /* _obj_map[0] is used for large objects and */
955 /* contains all nonzero entries. This gets us */
956 /* out of the marker fast path without an extra */
958 # define MAP_LEN BYTES_TO_GRANULES(HBLKSIZE)
960 # define VALID_OFFSET_SZ HBLKSIZE
961 char _valid_offsets[VALID_OFFSET_SZ];
962 /* GC_valid_offsets[i] == TRUE ==> i */
963 /* is registered as a displacement. */
964 char _modws_valid_offsets[sizeof(word)];
965 /* GC_valid_offsets[i] ==> */
966 /* GC_modws_valid_offsets[i%sizeof(word)] */
967 # ifdef STUBBORN_ALLOC
968 page_hash_table _changed_pages;
969 /* Stubborn object pages that were changes since last call to */
970 /* GC_read_changed. */
971 page_hash_table _prev_changed_pages;
972 /* Stubborn object pages that were changes before last call to */
973 /* GC_read_changed. */
975 # if defined(PROC_VDB) || defined(MPROTECT_VDB) || \
976 defined(GWW_VDB) || defined(MANUAL_VDB)
977 page_hash_table _grungy_pages; /* Pages that were dirty at last */
980 # if defined(MPROTECT_VDB) || defined(MANUAL_VDB)
981 volatile page_hash_table _dirty_pages;
982 /* Pages dirtied since last GC_read_dirty. */
984 # if defined(PROC_VDB) || defined(GWW_VDB)
985 page_hash_table _written_pages; /* Pages ever dirtied */
989 # define MAX_HEAP_SECTS 4096 /* overflows at roughly 64 GB */
991 # define MAX_HEAP_SECTS 768 /* Separately added heap sections. */
995 # define MAX_HEAP_SECTS 128 /* Roughly 256MB (128*2048*1K) */
997 # define MAX_HEAP_SECTS 384 /* Roughly 3GB */
1001 ptr_t hs_start; size_t hs_bytes;
1002 } _heap_sects[MAX_HEAP_SECTS]; /* Heap segments potentially */
1003 /* client objects. */
1004 # if defined(USE_PROC_FOR_LIBRARIES)
1005 struct HeapSect _our_memory[MAX_HEAP_SECTS];
1006 /* All GET_MEM allocated */
1007 /* memory. Includes block */
1008 /* headers and the like. */
1010 # if defined(MSWIN32) || defined(MSWINCE)
1011 ptr_t _heap_bases[MAX_HEAP_SECTS];
1012 /* Start address of memory regions obtained from kernel. */
1015 word _heap_lengths[MAX_HEAP_SECTS];
1016 /* Commited lengths of memory regions obtained from kernel. */
1018 struct roots _static_roots[MAX_ROOT_SETS];
1019 # if !defined(MSWIN32) && !defined(MSWINCE)
1020 struct roots * _root_index[RT_SIZE];
1022 struct exclusion _excl_table[MAX_EXCLUSIONS];
1023 /* Block header index; see gc_headers.h */
1024 bottom_index * _all_nils;
1025 bottom_index * _top_index [TOP_SZ];
1029 #ifdef SAVE_CALL_CHAIN
1030 struct callinfo _last_stack[NFRAMES]; /* Stack at last garbage collection.*/
1031 /* Useful for debugging mysterious */
1032 /* object disappearances. */
1033 /* In the multithreaded case, we */
1034 /* currently only save the calling */
1039 GC_API GC_FAR struct _GC_arrays GC_arrays;
1041 # ifndef SEPARATE_GLOBALS
1042 # define GC_objfreelist GC_arrays._objfreelist
1043 # define GC_aobjfreelist GC_arrays._aobjfreelist
1044 # define GC_bytes_allocd GC_arrays._bytes_allocd
1046 # define GC_uobjfreelist GC_arrays._uobjfreelist
1047 # ifdef ATOMIC_UNCOLLECTABLE
1048 # define GC_auobjfreelist GC_arrays._auobjfreelist
1050 # define GC_sobjfreelist GC_arrays._sobjfreelist
1051 # define GC_valid_offsets GC_arrays._valid_offsets
1052 # define GC_modws_valid_offsets GC_arrays._modws_valid_offsets
1053 # ifdef STUBBORN_ALLOC
1054 # define GC_changed_pages GC_arrays._changed_pages
1055 # define GC_prev_changed_pages GC_arrays._prev_changed_pages
1057 # ifdef MARK_BIT_PER_GRANULE
1058 # define GC_obj_map GC_arrays._obj_map
1060 # define GC_last_heap_addr GC_arrays._last_heap_addr
1061 # define GC_prev_heap_addr GC_arrays._prev_heap_addr
1062 # define GC_large_free_bytes GC_arrays._large_free_bytes
1063 # define GC_large_allocd_bytes GC_arrays._large_allocd_bytes
1064 # define GC_max_large_allocd_bytes GC_arrays._max_large_allocd_bytes
1065 # define GC_bytes_dropped GC_arrays._bytes_dropped
1066 # define GC_bytes_finalized GC_arrays._bytes_finalized
1067 # define GC_non_gc_bytes_at_gc GC_arrays._non_gc_bytes_at_gc
1068 # define GC_bytes_freed GC_arrays._bytes_freed
1069 # define GC_finalizer_bytes_freed GC_arrays._finalizer_bytes_freed
1070 # define GC_scratch_end_ptr GC_arrays._scratch_end_ptr
1071 # define GC_scratch_last_end_ptr GC_arrays._scratch_last_end_ptr
1072 # define GC_mark_procs GC_arrays._mark_procs
1073 # define GC_heapsize GC_arrays._heapsize
1074 # define GC_max_heapsize GC_arrays._max_heapsize
1075 # define GC_requested_heapsize GC_arrays._requested_heapsize
1076 # define GC_bytes_allocd_before_gc GC_arrays._bytes_allocd_before_gc
1077 # define GC_heap_sects GC_arrays._heap_sects
1078 # ifdef USE_PROC_FOR_LIBRARIES
1079 # define GC_our_memory GC_arrays._our_memory
1081 # define GC_last_stack GC_arrays._last_stack
1083 #define GC_trace_addr GC_arrays._trace_addr
1086 # define GC_unmapped_bytes GC_arrays._unmapped_bytes
1088 # if defined(MSWIN32) || defined(MSWINCE)
1089 # define GC_heap_bases GC_arrays._heap_bases
1092 # define GC_heap_lengths GC_arrays._heap_lengths
1094 # define GC_static_roots GC_arrays._static_roots
1095 # define GC_root_index GC_arrays._root_index
1096 # define GC_excl_table GC_arrays._excl_table
1097 # define GC_all_nils GC_arrays._all_nils
1098 # define GC_top_index GC_arrays._top_index
1099 # if defined(PROC_VDB) || defined(MPROTECT_VDB) || \
1100 defined(GWW_VDB) || defined(MANUAL_VDB)
1101 # define GC_grungy_pages GC_arrays._grungy_pages
1103 # if defined(MPROTECT_VDB) || defined(MANUAL_VDB)
1104 # define GC_dirty_pages GC_arrays._dirty_pages
1106 # if defined(PROC_VDB) || defined(GWW_VDB)
1107 # define GC_written_pages GC_arrays._written_pages
1109 # define GC_composite_in_use GC_arrays._composite_in_use
1110 # define GC_atomic_in_use GC_arrays._atomic_in_use
1111 # define GC_size_map GC_arrays._size_map
1113 # define beginGC_arrays ((ptr_t)(&GC_arrays))
1114 # define endGC_arrays (((ptr_t)(&GC_arrays)) + (sizeof GC_arrays))
1116 #define USED_HEAP_SIZE (GC_heapsize - GC_large_free_bytes)
1119 # define MAXOBJKINDS 16
1121 extern struct obj_kind {
1122 void **ok_freelist; /* Array of free listheaders for this kind of object */
1123 /* Point either to GC_arrays or to storage allocated */
1124 /* with GC_scratch_alloc. */
1125 struct hblk **ok_reclaim_list;
1126 /* List headers for lists of blocks waiting to be */
1128 /* Indexed by object size in granules. */
1129 word ok_descriptor; /* Descriptor template for objects in this */
1131 GC_bool ok_relocate_descr;
1132 /* Add object size in bytes to descriptor */
1133 /* template to obtain descriptor. Otherwise */
1134 /* template is used as is. */
1135 GC_bool ok_init; /* Clear objects before putting them on the free list. */
1136 } GC_obj_kinds[MAXOBJKINDS];
1138 # define beginGC_obj_kinds ((ptr_t)(&GC_obj_kinds))
1139 # define endGC_obj_kinds (beginGC_obj_kinds + (sizeof GC_obj_kinds))
1141 /* Variables that used to be in GC_arrays, but need to be accessed by */
1142 /* inline allocation code. If they were in GC_arrays, the inlined */
1143 /* allocation code would include GC_arrays offsets (as it did), which */
1144 /* introduce maintenance problems. */
1146 #ifdef SEPARATE_GLOBALS
1147 word GC_bytes_allocd;
1148 /* Number of words allocated during this collection cycle */
1149 ptr_t GC_objfreelist[MAXOBJGRANULES+1];
1150 /* free list for NORMAL objects */
1151 # define beginGC_objfreelist ((ptr_t)(&GC_objfreelist))
1152 # define endGC_objfreelist (beginGC_objfreelist + sizeof(GC_objfreelist))
1154 ptr_t GC_aobjfreelist[MAXOBJGRANULES+1];
1155 /* free list for atomic (PTRFREE) objs */
1156 # define beginGC_aobjfreelist ((ptr_t)(&GC_aobjfreelist))
1157 # define endGC_aobjfreelist (beginGC_aobjfreelist + sizeof(GC_aobjfreelist))
1160 /* Predefined kinds: */
1163 # define UNCOLLECTABLE 2
1164 # ifdef ATOMIC_UNCOLLECTABLE
1165 # define AUNCOLLECTABLE 3
1167 # define IS_UNCOLLECTABLE(k) (((k) & ~1) == UNCOLLECTABLE)
1170 # define IS_UNCOLLECTABLE(k) ((k) == UNCOLLECTABLE)
1173 extern unsigned GC_n_kinds;
1175 GC_API word GC_fo_entries;
1177 extern word GC_n_heap_sects; /* Number of separately added heap */
1180 #ifdef USE_PROC_FOR_LIBRARIES
1181 extern word GC_n_memory; /* Number of GET_MEM allocated memory */
1185 extern word GC_page_size;
1187 # if defined(MSWIN32) || defined(MSWINCE)
1188 struct _SYSTEM_INFO;
1189 extern struct _SYSTEM_INFO GC_sysinfo;
1190 extern word GC_n_heap_bases; /* See GC_heap_bases. */
1193 extern word GC_total_stack_black_listed;
1194 /* Number of bytes on stack blacklist. */
1196 extern word GC_black_list_spacing;
1197 /* Average number of bytes between blacklisted */
1198 /* blocks. Approximate. */
1199 /* Counts only blocks that are */
1200 /* "stack-blacklisted", i.e. that are */
1201 /* problematic in the interior of an object. */
1203 extern struct hblk * GC_hblkfreelist[];
1204 /* List of completely empty heap blocks */
1205 /* Linked through hb_next field of */
1206 /* header structure associated with */
1209 extern GC_bool GC_objects_are_marked; /* There are marked objects in */
1212 #ifndef SMALL_CONFIG
1213 extern GC_bool GC_incremental;
1214 /* Using incremental/generational collection. */
1215 # define TRUE_INCREMENTAL \
1216 (GC_incremental && GC_time_limit != GC_TIME_UNLIMITED)
1217 /* True incremental, not just generational, mode */
1219 # define GC_incremental FALSE
1220 /* Hopefully allow optimizer to remove some code. */
1221 # define TRUE_INCREMENTAL FALSE
1224 extern GC_bool GC_dirty_maintained;
1225 /* Dirty bits are being maintained, */
1226 /* either for incremental collection, */
1227 /* or to limit the root set. */
1229 extern word GC_root_size; /* Total size of registered root sections */
1231 extern GC_bool GC_debugging_started; /* GC_debug_malloc has been called. */
1233 extern long GC_large_alloc_warn_interval;
1234 /* Interval between unsuppressed warnings. */
1236 extern long GC_large_alloc_warn_suppressed;
1237 /* Number of warnings suppressed so far. */
1240 extern GC_bool GC_world_stopped;
1245 # define abs(x) ((x) < 0? (-(x)) : (x))
1249 /* Marks are in a reserved area in */
1250 /* each heap block. Each word has one mark bit associated */
1251 /* with it. Only those corresponding to the beginning of an */
1252 /* object are used. */
1254 /* Set mark bit correctly, even if mark bits may be concurrently */
1256 #ifdef PARALLEL_MARK
1257 # define OR_WORD(addr, bits) \
1258 { AO_or((volatile AO_t *)(addr), (AO_t)bits); }
1260 # define OR_WORD(addr, bits) *(addr) |= (bits)
1263 /* Mark bit operations */
1266 * Retrieve, set, clear the nth mark bit in a given heap block.
1268 * (Recall that bit n corresponds to nth object or allocation granule
1269 * relative to the beginning of the block, including unused words)
1272 #ifdef USE_MARK_BYTES
1273 # define mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[n])
1274 # define set_mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[n]) = 1
1275 # define clear_mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[n]) = 0
1276 #else /* !USE_MARK_BYTES */
1277 # define mark_bit_from_hdr(hhdr,n) (((hhdr)->hb_marks[divWORDSZ(n)] \
1278 >> (modWORDSZ(n))) & (word)1)
1279 # define set_mark_bit_from_hdr(hhdr,n) \
1280 OR_WORD((hhdr)->hb_marks+divWORDSZ(n), \
1281 (word)1 << modWORDSZ(n))
1282 # define clear_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1283 &= ~((word)1 << modWORDSZ(n))
1284 #endif /* !USE_MARK_BYTES */
1286 #ifdef MARK_BIT_PER_OBJ
1287 # define MARK_BIT_NO(offset, sz) (((unsigned)(offset))/(sz))
1288 /* Get the mark bit index corresponding to the given byte */
1289 /* offset and size (in bytes). */
1290 # define MARK_BIT_OFFSET(sz) 1
1291 /* Spacing between useful mark bits. */
1292 # define IF_PER_OBJ(x) x
1293 # define FINAL_MARK_BIT(sz) ((sz) > MAXOBJBYTES? 1 : HBLK_OBJS(sz))
1294 /* Position of final, always set, mark bit. */
1295 #else /* MARK_BIT_PER_GRANULE */
1296 # define MARK_BIT_NO(offset, sz) BYTES_TO_GRANULES((unsigned)(offset))
1297 # define MARK_BIT_OFFSET(sz) BYTES_TO_GRANULES(sz)
1298 # define IF_PER_OBJ(x)
1299 # define FINAL_MARK_BIT(sz) \
1300 ((sz) > MAXOBJBYTES? MARK_BITS_PER_HBLK \
1301 : BYTES_TO_GRANULES(sz * HBLK_OBJS(sz)))
1304 /* Important internal collector routines */
1306 ptr_t GC_approx_sp(void);
1308 GC_bool GC_should_collect(void);
1310 void GC_apply_to_all_blocks(void (*fn) (struct hblk *h, word client_data),
1312 /* Invoke fn(hbp, client_data) for each */
1313 /* allocated heap block. */
1314 struct hblk * GC_next_used_block(struct hblk * h);
1315 /* Return first in-use block >= h */
1316 struct hblk * GC_prev_block(struct hblk * h);
1317 /* Return last block <= h. Returned block */
1318 /* is managed by GC, but may or may not be in */
1320 void GC_mark_init(void);
1321 void GC_clear_marks(void); /* Clear mark bits for all heap objects. */
1322 void GC_invalidate_mark_state(void);
1323 /* Tell the marker that marked */
1324 /* objects may point to unmarked */
1325 /* ones, and roots may point to */
1326 /* unmarked objects. */
1327 /* Reset mark stack. */
1328 GC_bool GC_mark_stack_empty(void);
1329 GC_bool GC_mark_some(ptr_t cold_gc_frame);
1330 /* Perform about one pages worth of marking */
1331 /* work of whatever kind is needed. Returns */
1332 /* quickly if no collection is in progress. */
1333 /* Return TRUE if mark phase finished. */
1334 void GC_initiate_gc(void);
1335 /* initiate collection. */
1336 /* If the mark state is invalid, this */
1337 /* becomes full colleection. Otherwise */
1339 void GC_push_all(ptr_t bottom, ptr_t top);
1340 /* Push everything in a range */
1341 /* onto mark stack. */
1342 void GC_push_selected(ptr_t bottom, ptr_t top,
1343 int (*dirty_fn) (struct hblk *h),
1344 void (*push_fn) (ptr_t bottom, ptr_t top) );
1345 /* Push all pages h in [b,t) s.t. */
1346 /* select_fn(h) != 0 onto mark stack. */
1347 #ifndef SMALL_CONFIG
1348 void GC_push_conditional (ptr_t b, ptr_t t, GC_bool all);
1350 # define GC_push_conditional(b, t, all) GC_push_all(b, t)
1352 /* Do either of the above, depending */
1353 /* on the third arg. */
1354 void GC_push_all_stack (ptr_t b, ptr_t t);
1355 /* As above, but consider */
1356 /* interior pointers as valid */
1357 void GC_push_all_eager (ptr_t b, ptr_t t);
1358 /* Same as GC_push_all_stack, but */
1359 /* ensures that stack is scanned */
1360 /* immediately, not just scheduled */
1363 void GC_push_all_stack_partially_eager(ptr_t bottom, ptr_t top,
1364 ptr_t cold_gc_frame);
1365 /* Similar to GC_push_all_eager, but only the */
1366 /* part hotter than cold_gc_frame is scanned */
1367 /* immediately. Needed to ensure that callee- */
1368 /* save registers are not missed. */
1370 /* In the threads case, we push part of the current thread stack */
1371 /* with GC_push_all_eager when we push the registers. This gets the */
1372 /* callee-save registers that may disappear. The remainder of the */
1373 /* stacks are scheduled for scanning in *GC_push_other_roots, which */
1374 /* is thread-package-specific. */
1376 void GC_push_current_stack(ptr_t cold_gc_frame, void *context);
1377 /* Push enough of the current stack eagerly to */
1378 /* ensure that callee-save registers saved in */
1379 /* GC frames are scanned. */
1380 /* In the non-threads case, schedule entire */
1381 /* stack for scanning. */
1382 /* The second argument is a pointer to the */
1383 /* (possibly null) thread context, for */
1384 /* (currently hypothetical) more precise */
1385 /* stack scanning. */
1386 void GC_push_roots(GC_bool all, ptr_t cold_gc_frame);
1387 /* Push all or dirty roots. */
1388 extern void (*GC_push_other_roots)(void);
1389 /* Push system or application specific roots */
1390 /* onto the mark stack. In some environments */
1391 /* (e.g. threads environments) this is */
1392 /* predfined to be non-zero. A client supplied */
1393 /* replacement should also call the original */
1395 extern void GC_push_gc_structures(void);
1396 /* Push GC internal roots. These are normally */
1397 /* included in the static data segment, and */
1398 /* Thus implicitly pushed. But we must do this */
1399 /* explicitly if normal root processing is */
1400 /* disabled. Calls the following: */
1401 extern void GC_push_finalizer_structures(void);
1402 extern void GC_push_stubborn_structures (void);
1404 extern void GC_push_thread_structures (void);
1406 extern void (*GC_push_typed_structures) (void);
1407 /* A pointer such that we can avoid linking in */
1408 /* the typed allocation support if unused. */
1409 extern void (*GC_start_call_back) (void);
1410 /* Called at start of full collections. */
1411 /* Not called if 0. Called with allocation */
1414 void GC_push_regs_and_stack(ptr_t cold_gc_frame);
1416 void GC_push_regs(void);
1418 void GC_with_callee_saves_pushed(void (*fn)(ptr_t, void *),
1421 # if defined(SPARC) || defined(IA64)
1422 /* Cause all stacked registers to be saved in memory. Return a */
1423 /* pointer to the top of the corresponding memory stack. */
1424 ptr_t GC_save_regs_in_stack(void);
1426 /* Push register contents onto mark stack. */
1427 /* If NURSERY is defined, the default push */
1428 /* action can be overridden with GC_push_proc */
1431 extern void (*GC_push_proc)(ptr_t);
1433 # if defined(MSWIN32) || defined(MSWINCE)
1434 void __cdecl GC_push_one(word p);
1436 void GC_push_one(word p);
1437 /* If p points to an object, mark it */
1438 /* and push contents on the mark stack */
1439 /* Pointer recognition test always */
1440 /* accepts interior pointers, i.e. this */
1441 /* is appropriate for pointers found on */
1444 # if defined(PRINT_BLACK_LIST) || defined(KEEP_BACK_PTRS)
1445 void GC_mark_and_push_stack(ptr_t p, ptr_t source);
1446 /* Ditto, omits plausibility test */
1448 void GC_mark_and_push_stack(ptr_t p);
1450 void GC_push_marked(struct hblk * h, hdr * hhdr);
1451 /* Push contents of all marked objects in h onto */
1454 # define GC_push_next_marked_dirty(h) GC_push_next_marked(h)
1456 struct hblk * GC_push_next_marked_dirty(struct hblk * h);
1457 /* Invoke GC_push_marked on next dirty block above h. */
1458 /* Return a pointer just past the end of this block. */
1459 #endif /* !SMALL_CONFIG */
1460 struct hblk * GC_push_next_marked(struct hblk * h);
1461 /* Ditto, but also mark from clean pages. */
1462 struct hblk * GC_push_next_marked_uncollectable(struct hblk * h);
1463 /* Ditto, but mark only from uncollectable pages. */
1464 GC_bool GC_stopped_mark(GC_stop_func stop_func);
1465 /* Stop world and mark from all roots */
1467 void GC_clear_hdr_marks(hdr * hhdr);
1468 /* Clear the mark bits in a header */
1469 void GC_set_hdr_marks(hdr * hhdr);
1470 /* Set the mark bits in a header */
1471 void GC_set_fl_marks(ptr_t p);
1472 /* Set all mark bits associated with */
1474 #ifdef GC_ASSERTIONS
1475 void GC_check_fl_marks(ptr_t p);
1476 /* Check that all mark bits */
1477 /* associated with a free list are */
1478 /* set. Abort if not. */
1480 void GC_add_roots_inner(ptr_t b, ptr_t e, GC_bool tmp);
1481 void GC_remove_roots_inner(ptr_t b, ptr_t e);
1482 GC_bool GC_is_static_root(ptr_t p);
1483 /* Is the address p in one of the registered static */
1484 /* root sections? */
1485 # if defined(MSWIN32) || defined(_WIN32_WCE_EMULATION)
1486 GC_bool GC_is_tmp_root(ptr_t p);
1487 /* Is the address p in one of the temporary static */
1488 /* root sections? */
1490 void GC_register_dynamic_libraries(void);
1491 /* Add dynamic library data sections to the root set. */
1492 void GC_cond_register_dynamic_libraries(void);
1493 /* Remove and reregister dynamic libraries if we're */
1494 /* configured to do that at each GC. */
1496 GC_bool GC_register_main_static_data(void);
1497 /* We need to register the main data segment. Returns */
1498 /* TRUE unless this is done implicitly as part of */
1499 /* dynamic library registration. */
1501 /* Machine dependent startup routines */
1502 ptr_t GC_get_main_stack_base(void); /* Cold end of stack */
1504 ptr_t GC_get_register_stack_base(void);
1505 /* Cold end of register stack. */
1507 void GC_register_data_segments(void);
1509 /* Black listing: */
1510 void GC_bl_init(void);
1511 # ifdef PRINT_BLACK_LIST
1512 void GC_add_to_black_list_normal(word p, ptr_t source);
1513 /* Register bits as a possible future false */
1514 /* reference from the heap or static data */
1515 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1516 if (GC_all_interior_pointers) { \
1517 GC_add_to_black_list_stack((word)(bits), (source)); \
1519 GC_add_to_black_list_normal((word)(bits), (source)); \
1522 void GC_add_to_black_list_normal(word p);
1523 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1524 if (GC_all_interior_pointers) { \
1525 GC_add_to_black_list_stack((word)(bits)); \
1527 GC_add_to_black_list_normal((word)(bits)); \
1531 # ifdef PRINT_BLACK_LIST
1532 void GC_add_to_black_list_stack(word p, ptr_t source);
1533 # define GC_ADD_TO_BLACK_LIST_STACK(bits, source) \
1534 GC_add_to_black_list_stack((word)(bits), (source))
1536 void GC_add_to_black_list_stack(word p);
1537 # define GC_ADD_TO_BLACK_LIST_STACK(bits, source) \
1538 GC_add_to_black_list_stack((word)(bits))
1540 struct hblk * GC_is_black_listed(struct hblk * h, word len);
1541 /* If there are likely to be false references */
1542 /* to a block starting at h of the indicated */
1543 /* length, then return the next plausible */
1544 /* starting location for h that might avoid */
1545 /* these false references. */
1546 void GC_promote_black_lists(void);
1547 /* Declare an end to a black listing phase. */
1548 void GC_unpromote_black_lists(void);
1549 /* Approximately undo the effect of the above. */
1550 /* This actually loses some information, but */
1551 /* only in a reasonably safe way. */
1552 word GC_number_stack_black_listed(struct hblk *start, struct hblk *endp1);
1553 /* Return the number of (stack) blacklisted */
1554 /* blocks in the range for statistical */
1557 ptr_t GC_scratch_alloc(size_t bytes);
1558 /* GC internal memory allocation for */
1559 /* small objects. Deallocation is not */
1562 /* Heap block layout maps: */
1563 GC_bool GC_add_map_entry(size_t sz);
1564 /* Add a heap block map for objects of */
1565 /* size sz to obj_map. */
1566 /* Return FALSE on failure. */
1567 void GC_register_displacement_inner(size_t offset);
1568 /* Version of GC_register_displacement */
1569 /* that assumes lock is already held */
1570 /* and signals are already disabled. */
1572 void GC_initialize_offsets(void);
1573 /* Initialize GC_valid_offsets, */
1574 /* depending on current */
1575 /* GC_all_interior_pointers settings. */
1577 /* hblk allocation: */
1578 void GC_new_hblk(size_t size_in_granules, int kind);
1579 /* Allocate a new heap block, and build */
1580 /* a free list in it. */
1582 ptr_t GC_build_fl(struct hblk *h, size_t words, GC_bool clear, ptr_t list);
1583 /* Build a free list for objects of */
1584 /* size sz in block h. Append list to */
1585 /* end of the free lists. Possibly */
1586 /* clear objects on the list. Normally */
1587 /* called by GC_new_hblk, but also */
1588 /* called explicitly without GC lock. */
1590 struct hblk * GC_allochblk (size_t size_in_bytes, int kind,
1592 /* Allocate a heap block, inform */
1593 /* the marker that block is valid */
1594 /* for objects of indicated size. */
1596 ptr_t GC_alloc_large (size_t lb, int k, unsigned flags);
1597 /* Allocate a large block of size lb bytes. */
1598 /* The block is not cleared. */
1599 /* Flags is 0 or IGNORE_OFF_PAGE. */
1600 /* Calls GC_allchblk to do the actual */
1601 /* allocation, but also triggers GC and/or */
1602 /* heap expansion as appropriate. */
1603 /* Does not update GC_bytes_allocd, but does */
1604 /* other accounting. */
1606 ptr_t GC_alloc_large_and_clear(size_t lb, int k, unsigned flags);
1607 /* As above, but clear block if appropriate */
1610 void GC_freehblk(struct hblk * p);
1611 /* Deallocate a heap block and mark it */
1615 void GC_init_inner(void);
1616 GC_bool GC_expand_hp_inner(word n);
1617 void GC_start_reclaim(int abort_if_found);
1618 /* Restore unmarked objects to free */
1619 /* lists, or (if abort_if_found is */
1620 /* TRUE) report them. */
1621 /* Sweeping of small object pages is */
1622 /* largely deferred. */
1623 void GC_continue_reclaim(size_t sz, int kind);
1624 /* Sweep pages of the given size and */
1625 /* kind, as long as possible, and */
1626 /* as long as the corr. free list is */
1627 /* empty. Sz is in granules. */
1628 void GC_reclaim_or_delete_all(void);
1629 /* Arrange for all reclaim lists to be */
1630 /* empty. Judiciously choose between */
1631 /* sweeping and discarding each page. */
1632 GC_bool GC_reclaim_all(GC_stop_func stop_func, GC_bool ignore_old);
1633 /* Reclaim all blocks. Abort (in a */
1634 /* consistent state) if f returns TRUE. */
1635 ptr_t GC_reclaim_generic(struct hblk * hbp, hdr *hhdr, size_t sz,
1636 GC_bool init, ptr_t list, signed_word *count);
1637 /* Rebuild free list in hbp with */
1638 /* header hhdr, with objects of size sz */
1639 /* bytes. Add list to the end of the */
1640 /* free list. Add the number of */
1641 /* reclaimed bytes to *count. */
1642 GC_bool GC_block_empty(hdr * hhdr);
1643 /* Block completely unmarked? */
1644 GC_bool GC_never_stop_func(void);
1645 /* Returns FALSE. */
1646 GC_bool GC_try_to_collect_inner(GC_stop_func f);
1648 /* Collect; caller must have acquired */
1649 /* lock and disabled signals. */
1650 /* Collection is aborted if f returns */
1651 /* TRUE. Returns TRUE if it completes */
1653 # define GC_gcollect_inner() \
1654 (void) GC_try_to_collect_inner(GC_never_stop_func)
1655 void GC_finish_collection(void);
1656 /* Finish collection. Mark bits are */
1657 /* consistent and lock is still held. */
1658 GC_bool GC_collect_or_expand(word needed_blocks, GC_bool ignore_off_page);
1659 /* Collect or expand heap in an attempt */
1660 /* make the indicated number of free */
1661 /* blocks available. Should be called */
1662 /* until the blocks are available or */
1663 /* until it fails by returning FALSE. */
1665 extern GC_bool GC_is_initialized; /* GC_init() has been run. */
1667 #if defined(MSWIN32) || defined(MSWINCE)
1668 void GC_deinit(void);
1669 /* Free any resources allocated by */
1673 void GC_collect_a_little_inner(int n);
1674 /* Do n units worth of garbage */
1675 /* collection work, if appropriate. */
1676 /* A unit is an amount appropriate for */
1677 /* HBLKSIZE bytes of allocation. */
1678 /* void * GC_generic_malloc(size_t lb, int k); */
1679 /* Allocate an object of the given */
1680 /* kind. By default, there are only */
1681 /* a few kinds: composite(pointerfree), */
1682 /* atomic, uncollectable, etc. */
1683 /* We claim it's possible for clever */
1684 /* client code that understands GC */
1685 /* internals to add more, e.g. to */
1686 /* communicate object layout info */
1687 /* to the collector. */
1688 /* The actual decl is in gc_mark.h. */
1689 void * GC_generic_malloc_ignore_off_page(size_t b, int k);
1690 /* As above, but pointers past the */
1691 /* first page of the resulting object */
1693 void * GC_generic_malloc_inner(size_t lb, int k);
1694 /* Ditto, but I already hold lock, etc. */
1695 void * GC_generic_malloc_inner_ignore_off_page(size_t lb, int k);
1696 /* Allocate an object, where */
1697 /* the client guarantees that there */
1698 /* will always be a pointer to the */
1699 /* beginning of the object while the */
1700 /* object is live. */
1701 void GC_generic_malloc_many(size_t lb, int k, void **result);
1702 /* Store a pointer to a list of newly */
1703 /* allocated objects of kind k and size */
1704 /* lb in *result. */
1705 /* Caler must make sure that *result is */
1706 /* traced even if objects are ptrfree. */
1707 ptr_t GC_allocobj(size_t sz, int kind);
1708 /* Make the indicated */
1709 /* free list nonempty, and return its */
1710 /* head. Sz is in granules. */
1712 /* Allocation routines that bypass the thread local cache. */
1713 /* Used internally. */
1714 #ifdef THREAD_LOCAL_ALLOC
1715 void * GC_core_malloc(size_t);
1716 void * GC_core_malloc_atomic(size_t);
1717 # ifdef GC_GCJ_SUPPORT
1718 void *GC_core_gcj_malloc(size_t, void *);
1720 #endif /* THREAD_LOCAL_ALLOC */
1722 void GC_free_inner(void * p);
1723 void GC_debug_free_inner(void * p);
1725 void GC_init_headers(void);
1726 struct hblkhdr * GC_install_header(struct hblk *h);
1727 /* Install a header for block h. */
1728 /* Return 0 on failure, or the header */
1730 GC_bool GC_install_counts(struct hblk * h, size_t sz);
1731 /* Set up forwarding counts for block */
1733 /* Return FALSE on failure. */
1734 void GC_remove_header(struct hblk * h);
1735 /* Remove the header for block h. */
1736 void GC_remove_counts(struct hblk * h, size_t sz);
1737 /* Remove forwarding counts for h. */
1738 hdr * GC_find_header(ptr_t h); /* Debugging only. */
1740 void GC_finalize(void);
1741 /* Perform all indicated finalization actions */
1742 /* on unmarked objects. */
1743 /* Unreachable finalizable objects are enqueued */
1744 /* for processing by GC_invoke_finalizers. */
1745 /* Invoked with lock. */
1747 void GC_notify_or_invoke_finalizers(void);
1748 /* If GC_finalize_on_demand is not set, invoke */
1749 /* eligible finalizers. Otherwise: */
1750 /* Call *GC_finalizer_notifier if there are */
1751 /* finalizers to be run, and we haven't called */
1752 /* this procedure yet this GC cycle. */
1754 GC_API void * GC_make_closure(GC_finalization_proc fn, void * data);
1755 GC_API void GC_debug_invoke_finalizer(void * obj, void * data);
1756 /* Auxiliary fns to make finalization work */
1757 /* correctly with displaced pointers introduced */
1758 /* by the debugging allocators. */
1760 void GC_add_to_heap(struct hblk *p, size_t bytes);
1761 /* Add a HBLKSIZE aligned chunk to the heap. */
1763 #ifdef USE_PROC_FOR_LIBRARIES
1764 void GC_add_to_our_memory(ptr_t p, size_t bytes);
1765 /* Add a chunk to GC_our_memory. */
1766 /* If p == 0, do nothing. */
1768 # define GC_add_to_our_memory(p, bytes)
1771 void GC_print_obj(ptr_t p);
1772 /* P points to somewhere inside an object with */
1773 /* debugging info. Print a human readable */
1774 /* description of the object to stderr. */
1775 extern void (*GC_check_heap)(void);
1776 /* Check that all objects in the heap with */
1777 /* debugging info are intact. */
1778 /* Add any that are not to GC_smashed list. */
1779 extern void (*GC_print_all_smashed) (void);
1780 /* Print GC_smashed if it's not empty. */
1781 /* Clear GC_smashed list. */
1782 extern void GC_print_all_errors (void);
1783 /* Print smashed and leaked objects, if any. */
1784 /* Clear the lists of such objects. */
1785 extern void (*GC_print_heap_obj) (ptr_t p);
1786 /* If possible print s followed by a more */
1787 /* detailed description of the object */
1788 /* referred to by p. */
1789 #if defined(LINUX) && defined(__ELF__) && !defined(SMALL_CONFIG)
1790 void GC_print_address_map (void);
1791 /* Print an address map of the process. */
1794 extern GC_bool GC_have_errors; /* We saw a smashed or leaked object. */
1795 /* Call error printing routine */
1798 #ifndef SMALL_CONFIG
1799 extern int GC_print_stats; /* Nonzero generates basic GC log. */
1800 /* VERBOSE generates add'l messages. */
1802 # define GC_print_stats 0
1803 /* Will this keep the message character strings from the executable? */
1808 #ifndef NO_DEBUGGING
1809 extern GC_bool GC_dump_regularly; /* Generate regular debugging dumps. */
1810 # define COND_DUMP if (GC_dump_regularly) GC_dump();
1815 #ifdef KEEP_BACK_PTRS
1816 extern long GC_backtraces;
1817 void GC_generate_random_backtrace_no_gc(void);
1820 extern GC_bool GC_print_back_height;
1822 #ifdef MAKE_BACK_GRAPH
1823 void GC_print_back_graph_stats(void);
1826 /* Macros used for collector internal allocation. */
1827 /* These assume the collector lock is held. */
1829 extern void * GC_debug_generic_malloc_inner(size_t lb, int k);
1830 extern void * GC_debug_generic_malloc_inner_ignore_off_page(size_t lb,
1832 # define GC_INTERNAL_MALLOC GC_debug_generic_malloc_inner
1833 # define GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE \
1834 GC_debug_generic_malloc_inner_ignore_off_page
1836 # define GC_INTERNAL_FREE GC_debug_free_inner
1838 # define GC_INTERNAL_FREE GC_debug_free
1841 # define GC_INTERNAL_MALLOC GC_generic_malloc_inner
1842 # define GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE \
1843 GC_generic_malloc_inner_ignore_off_page
1845 # define GC_INTERNAL_FREE GC_free_inner
1847 # define GC_INTERNAL_FREE GC_free
1851 /* Memory unmapping: */
1853 void GC_unmap_old(void);
1854 void GC_merge_unmapped(void);
1855 void GC_unmap(ptr_t start, size_t bytes);
1856 void GC_remap(ptr_t start, size_t bytes);
1857 void GC_unmap_gap(ptr_t start1, size_t bytes1, ptr_t start2, size_t bytes2);
1860 /* Virtual dirty bit implementation: */
1861 /* Each implementation exports the following: */
1862 void GC_read_dirty(void);
1863 /* Retrieve dirty bits. */
1864 GC_bool GC_page_was_dirty(struct hblk *h);
1865 /* Read retrieved dirty bits. */
1866 GC_bool GC_page_was_ever_dirty(struct hblk *h);
1867 /* Could the page contain valid heap pointers? */
1868 void GC_remove_protection(struct hblk *h, word nblocks,
1869 GC_bool pointerfree);
1870 /* h is about to be writteni or allocated. Ensure */
1871 /* that it's not write protected by the virtual */
1872 /* dirty bit implementation. */
1874 void GC_dirty_init(void);
1876 /* Slow/general mark bit manipulation: */
1877 GC_API GC_bool GC_is_marked(ptr_t p);
1878 void GC_clear_mark_bit(ptr_t p);
1879 void GC_set_mark_bit(ptr_t p);
1881 /* Stubborn objects: */
1882 void GC_read_changed(void); /* Analogous to GC_read_dirty */
1883 GC_bool GC_page_was_changed(struct hblk * h);
1884 /* Analogous to GC_page_was_dirty */
1885 void GC_clean_changing_list(void);
1886 /* Collect obsolete changing list entries */
1887 void GC_stubborn_init(void);
1889 /* Debugging print routines: */
1890 void GC_print_block_list(void);
1891 void GC_print_hblkfreelist(void);
1892 void GC_print_heap_sects(void);
1893 void GC_print_static_roots(void);
1894 void GC_print_finalization_stats(void);
1895 /* void GC_dump(void); - declared in gc.h */
1897 #ifdef KEEP_BACK_PTRS
1898 void GC_store_back_pointer(ptr_t source, ptr_t dest);
1899 void GC_marked_for_finalization(ptr_t dest);
1900 # define GC_STORE_BACK_PTR(source, dest) GC_store_back_pointer(source, dest)
1901 # define GC_MARKED_FOR_FINALIZATION(dest) GC_marked_for_finalization(dest)
1903 # define GC_STORE_BACK_PTR(source, dest)
1904 # define GC_MARKED_FOR_FINALIZATION(dest)
1907 /* Make arguments appear live to compiler */
1909 void GC_noop(void*, ...);
1912 GC_API void GC_noop(...);
1914 GC_API void GC_noop();
1918 void GC_noop1(word);
1920 /* Logging and diagnostic output: */
1921 GC_API void GC_printf (const char * format, ...);
1922 /* A version of printf that doesn't allocate, */
1923 /* 1K total output length. */
1924 /* (We use sprintf. Hopefully that doesn't */
1925 /* allocate for long arguments.) */
1926 GC_API void GC_err_printf(const char * format, ...);
1927 GC_API void GC_log_printf(const char * format, ...);
1928 void GC_err_puts(const char *s);
1929 /* Write s to stderr, don't buffer, don't add */
1930 /* newlines, don't ... */
1932 #if defined(LINUX) && !defined(SMALL_CONFIG)
1933 void GC_err_write(const char *buf, size_t len);
1934 /* Write buf to stderr, don't buffer, don't add */
1935 /* newlines, don't ... */
1939 # ifdef GC_ASSERTIONS
1940 # define GC_ASSERT(expr) if(!(expr)) {\
1941 GC_err_printf("Assertion failure: %s:%ld\n", \
1942 __FILE__, (unsigned long)__LINE__); \
1943 ABORT("assertion failure"); }
1945 # define GC_ASSERT(expr)
1948 /* Check a compile time assertion at compile time. The error */
1949 /* message for failure is a bit baroque, but ... */
1950 #if defined(mips) && !defined(__GNUC__)
1951 /* DOB: MIPSPro C gets an internal error taking the sizeof an array type.
1952 This code works correctly (ugliness is to avoid "unused var" warnings) */
1953 # define GC_STATIC_ASSERT(expr) do { if (0) { char j[(expr)? 1 : -1]; j[0]='\0'; j[0]=j[0]; } } while(0)
1955 # define GC_STATIC_ASSERT(expr) sizeof(char[(expr)? 1 : -1])
1958 # if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
1959 /* We need additional synchronization facilities from the thread */
1960 /* support. We believe these are less performance critical */
1961 /* than the main garbage collector lock; standard pthreads-based */
1962 /* implementations should be sufficient. */
1964 /* The mark lock and condition variable. If the GC lock is also */
1965 /* acquired, the GC lock must be acquired first. The mark lock is */
1966 /* used to both protect some variables used by the parallel */
1967 /* marker, and to protect GC_fl_builder_count, below. */
1968 /* GC_notify_all_marker() is called when */
1969 /* the state of the parallel marker changes */
1970 /* in some significant way (see gc_mark.h for details). The */
1971 /* latter set of events includes incrementing GC_mark_no. */
1972 /* GC_notify_all_builder() is called when GC_fl_builder_count */
1975 extern void GC_acquire_mark_lock();
1976 extern void GC_release_mark_lock();
1977 extern void GC_notify_all_builder();
1978 /* extern void GC_wait_builder(); */
1979 extern void GC_wait_for_reclaim();
1981 extern word GC_fl_builder_count; /* Protected by mark lock. */
1982 # endif /* PARALLEL_MARK || THREAD_LOCAL_ALLOC */
1983 # ifdef PARALLEL_MARK
1984 extern void GC_notify_all_marker();
1985 extern void GC_wait_marker();
1986 extern word GC_mark_no; /* Protected by mark lock. */
1988 extern void GC_help_marker(word my_mark_no);
1989 /* Try to help out parallel marker for mark cycle */
1990 /* my_mark_no. Returns if the mark cycle finishes or */
1991 /* was already done, or there was nothing to do for */
1992 /* some other reason. */
1993 # endif /* PARALLEL_MARK */
1995 # if defined(GC_PTHREADS)
1996 /* We define the thread suspension signal here, so that we can refer */
1997 /* to it in the dirty bit implementation, if necessary. Ideally we */
1998 /* would allocate a (real-time ?) signal using the standard mechanism.*/
1999 /* unfortunately, there is no standard mechanism. (There is one */
2000 /* in Linux glibc, but it's not exported.) Thus we continue to use */
2001 /* the same hard-coded signals we've always used. */
2002 # if !defined(SIG_SUSPEND)
2003 # if defined(GC_LINUX_THREADS) || defined(GC_DGUX386_THREADS)
2004 # if defined(SPARC) && !defined(SIGPWR)
2005 /* SPARC/Linux doesn't properly define SIGPWR in <signal.h>.
2006 * It is aliased to SIGLOST in asm/signal.h, though. */
2007 # define SIG_SUSPEND SIGLOST
2009 /* Linuxthreads itself uses SIGUSR1 and SIGUSR2. */
2010 # define SIG_SUSPEND SIGPWR
2012 # else /* !GC_LINUX_THREADS */
2013 # if defined(_SIGRTMIN)
2014 # define SIG_SUSPEND _SIGRTMIN + 6
2016 # define SIG_SUSPEND SIGRTMIN + 6
2019 # endif /* !SIG_SUSPEND */
2023 /* Some macros for setjmp that works across signal handlers */
2024 /* were possible, and a couple of routines to facilitate */
2025 /* catching accesses to bad addresses when that's */
2026 /* possible/needed. */
2028 # include <setjmp.h>
2029 # if defined(SUNOS5SIGS) && !defined(FREEBSD)
2030 # include <sys/siginfo.h>
2032 /* Define SETJMP and friends to be the version that restores */
2033 /* the signal mask. */
2034 # define SETJMP(env) sigsetjmp(env, 1)
2035 # define LONGJMP(env, val) siglongjmp(env, val)
2036 # define JMP_BUF sigjmp_buf
2039 # define SETJMP(env) hal_setjmp(env)
2041 # define SETJMP(env) setjmp(env)
2043 # define LONGJMP(env, val) longjmp(env, val)
2044 # define JMP_BUF jmp_buf
2047 /* Do we need the GC_find_limit machinery to find the end of a */
2049 # if defined(HEURISTIC2) || defined(SEARCH_FOR_DATA_START)
2050 # define NEED_FIND_LIMIT
2053 # if !defined(STACKBOTTOM) && defined(HEURISTIC2)
2054 # define NEED_FIND_LIMIT
2057 # if (defined(SVR4) || defined(AUX) || defined(DGUX) \
2058 || (defined(LINUX) && defined(SPARC))) && !defined(PCR)
2059 # define NEED_FIND_LIMIT
2062 #if defined(FREEBSD) && (defined(I386) || defined(X86_64) || defined(powerpc) \
2063 || defined(__powerpc__))
2064 # include <machine/trap.h>
2066 # define NEED_FIND_LIMIT
2070 #if (defined(NETBSD) || defined(OPENBSD)) && defined(__ELF__) \
2071 && !defined(NEED_FIND_LIMIT)
2072 /* Used by GC_init_netbsd_elf() in os_dep.c. */
2073 # define NEED_FIND_LIMIT
2076 #if defined(IA64) && !defined(NEED_FIND_LIMIT)
2077 # define NEED_FIND_LIMIT
2078 /* May be needed for register backing store base. */
2081 # if defined(NEED_FIND_LIMIT) || \
2082 defined(USE_PROC_FOR_LIBRARIES) && defined(THREADS)
2085 /* Set up a handler for address faults which will longjmp to */
2087 extern void GC_setup_temporary_fault_handler(void);
2089 /* Undo the effect of GC_setup_temporary_fault_handler. */
2090 extern void GC_reset_fault_handler(void);
2092 # endif /* Need to handle address faults. */
2094 # endif /* GC_PRIVATE_H */
projects / cacao.git / blob