?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
* Makefile.in (PREPROCESSOR_DEFINES): New macro.
[official-gcc.git] / boehm-gc / gc_priv.h
blobcda9c23bacb98eaeff349c67a112b9e10bc2b67f
1 /*
2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1994 by Xerox Corporation. All rights reserved.
4 *
5 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
6 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
7 *
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.
13 */
14 /* Boehm, February 16, 1996 2:30 pm PST */
15
16
17 # ifndef GC_PRIVATE_H
18 # define GC_PRIVATE_H
19
20 #if defined(mips) && defined(SYSTYPE_BSD) && defined(sony_news)
21 /* sony RISC NEWS, NEWSOS 4 */
22 # define BSD_TIME
23 /* typedef long ptrdiff_t; -- necessary on some really old systems */
24 #endif
25
26 #if defined(mips) && defined(SYSTYPE_BSD43)
27 /* MIPS RISCOS 4 */
28 # define BSD_TIME
29 #endif
30
31 #ifdef BSD_TIME
32 # include <sys/types.h>
33 # include <sys/time.h>
34 # include <sys/resource.h>
35 #endif /* BSD_TIME */
36
37 # ifndef GC_H
38 # include "gc.h"
39 # endif
40
41 typedef GC_word word;
42 typedef GC_signed_word signed_word;
43
44 # ifndef CONFIG_H
45 # include "config.h"
46 # endif
47
48 # ifndef HEADERS_H
49 # include "gc_hdrs.h"
50 # endif
51
52 typedef int GC_bool;
53 # define TRUE 1
54 # define FALSE 0
55
56 typedef char * ptr_t; /* A generic pointer to which we can add */
57 /* byte displacements. */
58 /* Preferably identical to caddr_t, if it */
59 /* exists. */
60
61 #if defined(__STDC__)
62 # include <stdlib.h>
63 # if !(defined( sony_news ) )
64 # include <stddef.h>
65 # endif
66 # define VOLATILE volatile
67 # define CONST const
68 #else
69 # ifdef MSWIN32
70 # include <stdlib.h>
71 # endif
72 # define VOLATILE
73 # define CONST
74 #endif
75
76 #ifdef AMIGA
77 # define GC_FAR __far
78 #else
79 # define GC_FAR
80 #endif
81
82 /*********************************/
83 /* */
84 /* Definitions for conservative */
85 /* collector */
86 /* */
87 /*********************************/
88
89 /*********************************/
90 /* */
91 /* Easily changeable parameters */
92 /* */
93 /*********************************/
94
95 #define STUBBORN_ALLOC /* Define stubborn allocation primitives */
96 #if defined(SRC_M3) || defined(SMALL_CONFIG)
97 # undef STUBBORN_ALLOC
98 #endif
99
100
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 */
123 /* touched. */
124 /* If you can easily avoid using this option, do. */
125 /* If not, try to keep individual objects small. */
126
127 #define PRINTSTATS /* Print garbage collection statistics */
128 /* For less verbose output, undefine in reclaim.c */
129
130 #define PRINTTIMES /* Print the amount of time consumed by each garbage */
131 /* collection. */
132
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. */
138 #undef PRINTBLOCKS
139
140 #ifdef SILENT
141 # ifdef PRINTSTATS
142 # undef PRINTSTATS
143 # endif
144 # ifdef PRINTTIMES
145 # undef PRINTTIMES
146 # endif
147 # ifdef PRINTNBLOCKS
148 # undef PRINTNBLOCKS
149 # endif
150 #endif
151
152 #if defined(PRINTSTATS) && !defined(GATHERSTATS)
153 # define GATHERSTATS
154 #endif
155
156 #ifdef FINALIZE_ON_DEMAND
157 # define GC_INVOKE_FINALIZERS()
158 #else
159 # define GC_INVOKE_FINALIZERS() (void)GC_invoke_finalizers()
160 #endif
161
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 */
171 /* entries. */
172
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 */
179 /* heap. */
180 #endif
181
182 /* ALIGN_DOUBLE requires MERGE_SIZES at present. */
183 # if defined(ALIGN_DOUBLE) && !defined(MERGE_SIZES)
184 # define MERGE_SIZES
185 # endif
186
187 #if defined(ALL_INTERIOR_POINTERS) && !defined(DONT_ADD_BYTE_AT_END)
188 # define ADD_BYTE_AT_END
189 #endif
190
191
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 */
196 # else
197 # define MINHINCR 64
198 # define MAXHINCR 4096
199 # endif
200
201 # define TIME_LIMIT 50 /* We try to keep pause times from exceeding */
202 /* this by much. In milliseconds. */
203
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 */
214 /* heap growth. */
215
216 /*********************************/
217 /* */
218 /* Stack saving for debugging */
219 /* */
220 /*********************************/
221
222 #ifdef SAVE_CALL_CHAIN
223
224 /*
225 * Number of frames and arguments to save in objects allocated by
226 * debugging allocator.
227 */
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. */
231
232 # define NEED_CALLINFO
233
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] */);
237
238 void GC_print_callers (/* struct callinfo info[NFRAMES] */);
239
240 #else
241
242 # ifdef GC_ADD_CALLER
243 # define NFRAMES 1
244 # define NARGS 0
245 # define NEED_CALLINFO
246 # endif
247
248 #endif
249
250 #ifdef NEED_CALLINFO
251 struct callinfo {
252 word ci_pc;
253 # if NARGS > 0
254 word ci_arg[NARGS]; /* bit-wise complement to avoid retention */
255 # endif
256 # if defined(ALIGN_DOUBLE) && (NFRAMES * (NARGS + 1)) % 2 == 1
257 /* Likely alignment problem. */
258 word ci_dummy;
259 # endif
260 };
261 #endif
262
263
264 /*********************************/
265 /* */
266 /* OS interface routines */
267 /* */
268 /*********************************/
269
270 #ifdef BSD_TIME
271 # undef CLOCK_TYPE
272 # undef GET_TIME
273 # undef MS_TIME_DIFF
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 */
281 # include <time.h>
282 # if !defined(__STDC__) && defined(SPARC) && defined(SUNOS4)
283 clock_t clock(); /* Not in time.h, where it belongs */
284 # endif
285 # if defined(FREEBSD) && !defined(CLOCKS_PER_SEC)
286 # include <machine/limits.h>
287 # define CLOCKS_PER_SEC CLK_TCK
288 # endif
289 # if !defined(CLOCKS_PER_SEC)
290 # define CLOCKS_PER_SEC 1000000
291 /*
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).
300 */
301 # endif
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 */
307
308 /* We use bzero and bcopy internally. They may not be available. */
309 # if defined(SPARC) && defined(SUNOS4)
310 # define BCOPY_EXISTS
311 # endif
312 # if defined(M68K) && defined(AMIGA)
313 # define BCOPY_EXISTS
314 # endif
315 # if defined(M68K) && defined(NEXT)
316 # define BCOPY_EXISTS
317 # endif
318 # if defined(VAX)
319 # define BCOPY_EXISTS
320 # endif
321 # if defined(AMIGA)
322 # include <string.h>
323 # define BCOPY_EXISTS
324 # endif
325
326 # ifndef BCOPY_EXISTS
327 # include <string.h>
328 # define BCOPY(x,y,n) memcpy(y, x, (size_t)(n))
329 # define BZERO(x,n) memset(x, 0, (size_t)(n))
330 # else
331 # define BCOPY(x,y,n) bcopy((char *)(x),(char *)(y),(int)(n))
332 # define BZERO(x,n) bzero((char *)(x),(int)(n))
333 # endif
334
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. */
339 # ifdef PCR
340 char * real_malloc();
341 # define GET_MEM(bytes) HBLKPTR(real_malloc((size_t)bytes + GC_page_size) \
342 + GC_page_size-1)
343 # else
344 # ifdef OS2
345 void * os2_alloc(size_t bytes);
346 # define GET_MEM(bytes) HBLKPTR((ptr_t)os2_alloc((size_t)bytes \
347 + GC_page_size) \
348 + GC_page_size-1)
349 # else
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) \
353 + GC_page_size-1)
354 # else
355 # ifdef MSWIN32
356 extern ptr_t GC_win32_get_mem();
357 # define GET_MEM(bytes) (struct hblk *)GC_win32_get_mem(bytes)
358 # else
359 # ifdef MACOS
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) \
365 + GC_page_size-1)
366 # else
367 # define GET_MEM(bytes) HBLKPTR( \
368 NewPtrClear(bytes + GC_page_size) + GC_page_size-1)
369 # endif
370 # else
371 extern ptr_t GC_unix_get_mem();
372 # define GET_MEM(bytes) (struct hblk *)GC_unix_get_mem(bytes)
373 # endif
374 # endif
375 # endif
376 # endif
377 # endif
378
379 /*
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
390 * not restarted.
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.)
394 */
395 # ifdef THREADS
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()
408 # endif
409 # ifdef PCR
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); }
421 # endif
422 # ifdef SRC_M3
423 extern word RT0u__inCritical;
424 # define LOCK() RT0u__inCritical++
425 # define UNLOCK() RT0u__inCritical--
426 # endif
427 # ifdef SOLARIS_THREADS
428 # include <thread.h>
429 # include <signal.h>
430 extern mutex_t GC_allocate_ml;
431 # define LOCK() mutex_lock(&GC_allocate_ml);
432 # define UNLOCK() mutex_unlock(&GC_allocate_ml);
433 # endif
434 # ifdef LINUX_THREADS
435 # include <pthread.h>
436 # ifdef __i386__
437 inline static int GC_test_and_set(volatile unsigned int *addr) {
438 int oldval;
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)));
443 return oldval;
444 }
445 inline static void GC_clear(volatile unsigned int *addr) {
446 *(addr) = 0;
447 }
448 # elif defined(__alpha__)
449 inline static int GC_test_and_set(volatile unsigned int *addr) {
450 long oldval, temp;
451
452 __asm__ __volatile__(
453 "1:\tldl_l %0,%3\n"
454 "\tbne %0,2f\n"
455 "\tor $31,1,%1\n"
456 "\tstl_c %1,%2\n"
457 "\tbeq %1,1b\n"
458 "2:\tmb\n"
459 : "=&r"(oldval), "=&r"(temp), "=m"(*(addr))
460 : "m"(*(addr))
461 : "memory");
462 return (int)oldval;
463 }
464 inline static void GC_clear(volatile unsigned int *addr) {
465 __asm__ __volatile__("mb": : :"memory");
466 *(addr) = 0;
467 }
468 # elif defined(__powerpc__)
469 inline static int GC_test_and_set(volatile unsigned int *addr) {
470 int ret, oldval=0, newval=1;
471
472 __asm__ __volatile__("sync" : : : "memory");
473 __asm__ __volatile__(
474 "0: lwarx %0,0,%1 ;"
475 " xor. %0,%3,%0;"
476 " bne 1f;"
477 " stwcx. %2,0,%1;"
478 " bne- 0b;"
479 "1: "
480 : "=&r"(ret)
481 : "r"(addr), "r"(newval), "r"(oldval)
482 : "cr0", "memory");
483 __asm__ __volatile__("sync" : : : "memory");
484 return ret == 0;
485 }
486 inline static void GC_clear(volatile unsigned int *addr) {
487 __asm__ __volatile__("sync": : :"memory");
488 *(addr) = 0;
489 }
490
491 # else
492 -- > Need implementation of GC_test_and_set()
493 # endif
494
495 extern volatile unsigned int GC_allocate_lock;
496 /* This is not a mutex because mutexes that obey the (optional) */
497 /* POSIX scheduling rules are subject to convoys in high contention */
498 /* applications. This is basically a spin lock. */
499 extern pthread_t GC_lock_holder;
500 extern void GC_lock(void);
501 /* Allocation lock holder. Only set if acquired by client through */
502 /* GC_call_with_alloc_lock. */
503 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
504 # define NO_THREAD (pthread_t)(-1)
505 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
506 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
507 # ifdef UNDEFINED
508 # define LOCK() pthread_mutex_lock(&GC_allocate_ml)
509 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
510 # else
511 # define LOCK() \
512 { if (GC_test_and_set(&GC_allocate_lock)) GC_lock(); }
513 # define UNLOCK() \
514 GC_clear(&GC_allocate_lock)
515 # endif
516 extern GC_bool GC_collecting;
517 # define ENTER_GC() \
518 { \
519 GC_collecting = 1; \
520 }
521 # define EXIT_GC() GC_collecting = 0;
522 # endif /* LINUX_THREADS */
523 # if defined(IRIX_THREADS) || defined(IRIX_JDK_THREADS)
524 # include <pthread.h>
525 # include <mutex.h>
526
527 # if __mips < 3 || !(defined (_ABIN32) || defined(_ABI64)) \
528 || !defined(_COMPILER_VERSION) || _COMPILER_VERSION < 700
529 # define GC_test_and_set(addr, v) test_and_set(addr,v)
530 # else
531 # define GC_test_and_set(addr, v) __test_and_set(addr,v)
532 # endif
533 extern unsigned long GC_allocate_lock;
534 /* This is not a mutex because mutexes that obey the (optional) */
535 /* POSIX scheduling rules are subject to convoys in high contention */
536 /* applications. This is basically a spin lock. */
537 extern pthread_t GC_lock_holder;
538 extern void GC_lock(void);
539 /* Allocation lock holder. Only set if acquired by client through */
540 /* GC_call_with_alloc_lock. */
541 # define SET_LOCK_HOLDER() GC_lock_holder = pthread_self()
542 # define NO_THREAD (pthread_t)(-1)
543 # define UNSET_LOCK_HOLDER() GC_lock_holder = NO_THREAD
544 # define I_HOLD_LOCK() (pthread_equal(GC_lock_holder, pthread_self()))
545 # ifdef UNDEFINED
546 # define LOCK() pthread_mutex_lock(&GC_allocate_ml)
547 # define UNLOCK() pthread_mutex_unlock(&GC_allocate_ml)
548 # else
549 # define LOCK() { if (GC_test_and_set(&GC_allocate_lock, 1)) GC_lock(); }
550 # if __mips >= 3 && (defined (_ABIN32) || defined(_ABI64)) \
551 && defined(_COMPILER_VERSION) && _COMPILER_VERSION >= 700
552 # define UNLOCK() __lock_release(&GC_allocate_lock)
553 # else
554 /* The function call in the following should prevent the */
555 /* compiler from moving assignments to below the UNLOCK. */
556 /* This is probably not necessary for ucode or gcc 2.8. */
557 /* It may be necessary for Ragnarok and future gcc */
558 /* versions. */
559 # define UNLOCK() { GC_noop1(&GC_allocate_lock); \
560 *(volatile unsigned long *)(&GC_allocate_lock) = 0; }
561 # endif
562 # endif
563 extern GC_bool GC_collecting;
564 # define ENTER_GC() \
565 { \
566 GC_collecting = 1; \
567 }
568 # define EXIT_GC() GC_collecting = 0;
569 # endif /* IRIX_THREADS || IRIX_JDK_THREADS */
570 # ifdef WIN32_THREADS
571 # include <windows.h>
572 GC_API CRITICAL_SECTION GC_allocate_ml;
573 # define LOCK() EnterCriticalSection(&GC_allocate_ml);
574 # define UNLOCK() LeaveCriticalSection(&GC_allocate_ml);
575 # endif
576 # ifdef QUICK_THREADS
577 # define LOCK()
578 # define UNLOCK()
579 # endif
580 # ifndef SET_LOCK_HOLDER
581 # define SET_LOCK_HOLDER()
582 # define UNSET_LOCK_HOLDER()
583 # define I_HOLD_LOCK() FALSE
584 /* Used on platforms were locks can be reacquired, */
585 /* so it doesn't matter if we lie. */
586 # endif
587 # else
588 # define LOCK()
589 # define UNLOCK()
590 # endif
591 # ifndef SET_LOCK_HOLDER
592 # define SET_LOCK_HOLDER()
593 # define UNSET_LOCK_HOLDER()
594 # define I_HOLD_LOCK() FALSE
595 /* Used on platforms were locks can be reacquired, */
596 /* so it doesn't matter if we lie. */
597 # endif
598 # ifndef ENTER_GC
599 # define ENTER_GC()
600 # define EXIT_GC()
601 # endif
602
603 # ifndef DCL_LOCK_STATE
604 # define DCL_LOCK_STATE
605 # endif
606 # ifndef FASTLOCK
607 # define FASTLOCK() LOCK()
608 # define FASTLOCK_SUCCEEDED() TRUE
609 # define FASTUNLOCK() UNLOCK()
610 # endif
611
612 /* Delay any interrupts or signals that may abort this thread. Data */
613 /* structures are in a consistent state outside this pair of calls. */
614 /* ANSI C allows both to be empty (though the standard isn't very */
615 /* clear on that point). Standard malloc implementations are usually */
616 /* neither interruptable nor thread-safe, and thus correspond to */
617 /* empty definitions. */
618 # ifdef PCR
619 # define DISABLE_SIGNALS() \
620 PCR_Th_SetSigMask(PCR_allSigsBlocked,&GC_old_sig_mask)
621 # define ENABLE_SIGNALS() \
622 PCR_Th_SetSigMask(&GC_old_sig_mask, NIL)
623 # else
624 # if defined(SRC_M3) || defined(AMIGA) || defined(SOLARIS_THREADS) \
625 || defined(MSWIN32) || defined(MACOS) || defined(DJGPP) \
626 || defined(NO_SIGNALS) || defined(IRIX_THREADS) \
627 || defined(IRIX_JDK_THREADS) || defined(LINUX_THREADS)
628 /* Also useful for debugging. */
629 /* Should probably use thr_sigsetmask for SOLARIS_THREADS. */
630 # define DISABLE_SIGNALS()
631 # define ENABLE_SIGNALS()
632 # else
633 # define DISABLE_SIGNALS() GC_disable_signals()
634 void GC_disable_signals();
635 # define ENABLE_SIGNALS() GC_enable_signals()
636 void GC_enable_signals();
637 # endif
638 # endif
639
640 /*
641 * Stop and restart mutator threads.
642 */
643 # ifdef PCR
644 # include "th/PCR_ThCtl.h"
645 # define STOP_WORLD() \
646 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_stopNormal, \
647 PCR_allSigsBlocked, \
648 PCR_waitForever)
649 # define START_WORLD() \
650 PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_null, \
651 PCR_allSigsBlocked, \
652 PCR_waitForever);
653 # else
654 # if defined(SOLARIS_THREADS) || defined(WIN32_THREADS) \
655 || defined(IRIX_THREADS) || defined(LINUX_THREADS) \
656 || defined(IRIX_JDK_THREADS)
657 void GC_stop_world();
658 void GC_start_world();
659 # define STOP_WORLD() GC_stop_world()
660 # define START_WORLD() GC_start_world()
661 # else
662 # define STOP_WORLD()
663 # define START_WORLD()
664 # endif
665 # endif
666
667 /* Abandon ship */
668 # ifdef PCR
669 # define ABORT(s) PCR_Base_Panic(s)
670 # else
671 # ifdef SMALL_CONFIG
672 # define ABORT(msg) abort();
673 # else
674 GC_API void GC_abort();
675 # define ABORT(msg) GC_abort(msg);
676 # endif
677 # endif
678
679 /* Exit abnormally, but without making a mess (e.g. out of memory) */
680 # ifdef PCR
681 # define EXIT() PCR_Base_Exit(1,PCR_waitForever)
682 # else
683 # define EXIT() (void)exit(1)
684 # endif
685
686 /* Print warning message, e.g. almost out of memory. */
687 # define WARN(msg,arg) (*GC_current_warn_proc)(msg, (GC_word)(arg))
688 extern GC_warn_proc GC_current_warn_proc;
689
690 /*********************************/
691 /* */
692 /* Word-size-dependent defines */
693 /* */
694 /*********************************/
695
696 #if CPP_WORDSZ == 32
697 # define WORDS_TO_BYTES(x) ((x)<<2)
698 # define BYTES_TO_WORDS(x) ((x)>>2)
699 # define LOGWL ((word)5) /* log[2] of CPP_WORDSZ */
700 # define modWORDSZ(n) ((n) & 0x1f) /* n mod size of word */
701 # if ALIGNMENT != 4
702 # define UNALIGNED
703 # endif
704 #endif
705
706 #if CPP_WORDSZ == 64
707 # define WORDS_TO_BYTES(x) ((x)<<3)
708 # define BYTES_TO_WORDS(x) ((x)>>3)
709 # define LOGWL ((word)6) /* log[2] of CPP_WORDSZ */
710 # define modWORDSZ(n) ((n) & 0x3f) /* n mod size of word */
711 # if ALIGNMENT != 8
712 # define UNALIGNED
713 # endif
714 #endif
715
716 #define WORDSZ ((word)CPP_WORDSZ)
717 #define SIGNB ((word)1 << (WORDSZ-1))
718 #define BYTES_PER_WORD ((word)(sizeof (word)))
719 #define ONES ((word)(-1))
720 #define divWORDSZ(n) ((n) >> LOGWL) /* divide n by size of word */
721
722 /*********************/
723 /* */
724 /* Size Parameters */
725 /* */
726 /*********************/
727
728 /* heap block size, bytes. Should be power of 2 */
729
730 #ifndef HBLKSIZE
731 # ifdef SMALL_CONFIG
732 # define CPP_LOG_HBLKSIZE 10
733 # else
734 # if CPP_WORDSZ == 32
735 # define CPP_LOG_HBLKSIZE 12
736 # else
737 # define CPP_LOG_HBLKSIZE 13
738 # endif
739 # endif
740 #else
741 # if HBLKSIZE == 512
742 # define CPP_LOG_HBLKSIZE 9
743 # endif
744 # if HBLKSIZE == 1024
745 # define CPP_LOG_HBLKSIZE 10
746 # endif
747 # if HBLKSIZE == 2048
748 # define CPP_LOG_HBLKSIZE 11
749 # endif
750 # if HBLKSIZE == 4096
751 # define CPP_LOG_HBLKSIZE 12
752 # endif
753 # if HBLKSIZE == 8192
754 # define CPP_LOG_HBLKSIZE 13
755 # endif
756 # if HBLKSIZE == 16384
757 # define CPP_LOG_HBLKSIZE 14
758 # endif
759 # ifndef CPP_LOG_HBLKSIZE
760 --> fix HBLKSIZE
761 # endif
762 # undef HBLKSIZE
763 #endif
764 # define CPP_HBLKSIZE (1 << CPP_LOG_HBLKSIZE)
765 # define LOG_HBLKSIZE ((word)CPP_LOG_HBLKSIZE)
766 # define HBLKSIZE ((word)CPP_HBLKSIZE)
767
768
769 /* max size objects supported by freelist (larger objects may be */
770 /* allocated, but less efficiently) */
771
772 #define CPP_MAXOBJSZ BYTES_TO_WORDS(CPP_HBLKSIZE/2)
773 #define MAXOBJSZ ((word)CPP_MAXOBJSZ)
774
775 # define divHBLKSZ(n) ((n) >> LOG_HBLKSIZE)
776
777 # define HBLK_PTR_DIFF(p,q) divHBLKSZ((ptr_t)p - (ptr_t)q)
778 /* Equivalent to subtracting 2 hblk pointers. */
779 /* We do it this way because a compiler should */
780 /* find it hard to use an integer division */
781 /* instead of a shift. The bundled SunOS 4.1 */
782 /* o.w. sometimes pessimizes the subtraction to */
783 /* involve a call to .div. */
784
785 # define modHBLKSZ(n) ((n) & (HBLKSIZE-1))
786
787 # define HBLKPTR(objptr) ((struct hblk *)(((word) (objptr)) & ~(HBLKSIZE-1)))
788
789 # define HBLKDISPL(objptr) (((word) (objptr)) & (HBLKSIZE-1))
790
791 /* Round up byte allocation requests to integral number of words, etc. */
792 # ifdef ADD_BYTE_AT_END
793 # define ROUNDED_UP_WORDS(n) BYTES_TO_WORDS((n) + WORDS_TO_BYTES(1))
794 # ifdef ALIGN_DOUBLE
795 # define ALIGNED_WORDS(n) (BYTES_TO_WORDS((n) + WORDS_TO_BYTES(2)) & ~1)
796 # else
797 # define ALIGNED_WORDS(n) ROUNDED_UP_WORDS(n)
798 # endif
799 # define SMALL_OBJ(bytes) ((bytes) < WORDS_TO_BYTES(MAXOBJSZ))
800 # define ADD_SLOP(bytes) ((bytes)+1)
801 # else
802 # define ROUNDED_UP_WORDS(n) BYTES_TO_WORDS((n) + (WORDS_TO_BYTES(1) - 1))
803 # ifdef ALIGN_DOUBLE
804 # define ALIGNED_WORDS(n) \
805 (BYTES_TO_WORDS((n) + WORDS_TO_BYTES(2) - 1) & ~1)
806 # else
807 # define ALIGNED_WORDS(n) ROUNDED_UP_WORDS(n)
808 # endif
809 # define SMALL_OBJ(bytes) ((bytes) <= WORDS_TO_BYTES(MAXOBJSZ))
810 # define ADD_SLOP(bytes) (bytes)
811 # endif
812
813
814 /*
815 * Hash table representation of sets of pages. This assumes it is
816 * OK to add spurious entries to sets.
817 * Used by black-listing code, and perhaps by dirty bit maintenance code.
818 */
819
820 # ifdef LARGE_CONFIG
821 # define LOG_PHT_ENTRIES 17
822 # else
823 # define LOG_PHT_ENTRIES 14 /* Collisions are likely if heap grows */
824 /* to more than 16K hblks = 64MB. */
825 /* Each hash table occupies 2K bytes. */
826 # endif
827 # define PHT_ENTRIES ((word)1 << LOG_PHT_ENTRIES)
828 # define PHT_SIZE (PHT_ENTRIES >> LOGWL)
829 typedef word page_hash_table[PHT_SIZE];
830
831 # define PHT_HASH(addr) ((((word)(addr)) >> LOG_HBLKSIZE) & (PHT_ENTRIES - 1))
832
833 # define get_pht_entry_from_index(bl, index) \
834 (((bl)[divWORDSZ(index)] >> modWORDSZ(index)) & 1)
835 # define set_pht_entry_from_index(bl, index) \
836 (bl)[divWORDSZ(index)] |= (word)1 << modWORDSZ(index)
837 # define clear_pht_entry_from_index(bl, index) \
838 (bl)[divWORDSZ(index)] &= ~((word)1 << modWORDSZ(index))
839
840
841
842 /********************************************/
843 /* */
844 /* H e a p B l o c k s */
845 /* */
846 /********************************************/
847
848 /* heap block header */
849 #define HBLKMASK (HBLKSIZE-1)
850
851 #define BITS_PER_HBLK (HBLKSIZE * 8)
852
853 #define MARK_BITS_PER_HBLK (BITS_PER_HBLK/CPP_WORDSZ)
854 /* upper bound */
855 /* We allocate 1 bit/word. Only the first word */
856 /* in each object is actually marked. */
857
858 # ifdef ALIGN_DOUBLE
859 # define MARK_BITS_SZ (((MARK_BITS_PER_HBLK + 2*CPP_WORDSZ - 1) \
860 / (2*CPP_WORDSZ))*2)
861 # else
862 # define MARK_BITS_SZ ((MARK_BITS_PER_HBLK + CPP_WORDSZ - 1)/CPP_WORDSZ)
863 # endif
864 /* Upper bound on number of mark words per heap block */
865
866 struct hblkhdr {
867 word hb_sz; /* If in use, size in words, of objects in the block. */
868 /* if free, the size in bytes of the whole block */
869 struct hblk * hb_next; /* Link field for hblk free list */
870 /* and for lists of chunks waiting to be */
871 /* reclaimed. */
872 word hb_descr; /* object descriptor for marking. See */
873 /* mark.h. */
874 char* hb_map; /* A pointer to a pointer validity map of the block. */
875 /* See GC_obj_map. */
876 /* Valid for all blocks with headers. */
877 /* Free blocks point to GC_invalid_map. */
878 unsigned char hb_obj_kind;
879 /* Kind of objects in the block. Each kind */
880 /* identifies a mark procedure and a set of */
881 /* list headers. Sometimes called regions. */
882 unsigned char hb_flags;
883 # define IGNORE_OFF_PAGE 1 /* Ignore pointers that do not */
884 /* point to the first page of */
885 /* this object. */
886 unsigned short hb_last_reclaimed;
887 /* Value of GC_gc_no when block was */
888 /* last allocated or swept. May wrap. */
889 word hb_marks[MARK_BITS_SZ];
890 /* Bit i in the array refers to the */
891 /* object starting at the ith word (header */
892 /* INCLUDED) in the heap block. */
893 /* The lsb of word 0 is numbered 0. */
894 };
895
896 /* heap block body */
897
898 # define DISCARD_WORDS 0
899 /* Number of words to be dropped at the beginning of each block */
900 /* Must be a multiple of WORDSZ. May reasonably be nonzero */
901 /* on machines that don't guarantee longword alignment of */
902 /* pointers, so that the number of false hits is minimized. */
903 /* 0 and WORDSZ are probably the only reasonable values. */
904
905 # define BODY_SZ ((HBLKSIZE-WORDS_TO_BYTES(DISCARD_WORDS))/sizeof(word))
906
907 struct hblk {
908 # if (DISCARD_WORDS != 0)
909 word garbage[DISCARD_WORDS];
910 # endif
911 word hb_body[BODY_SZ];
912 };
913
914 # define HDR_WORDS ((word)DISCARD_WORDS)
915 # define HDR_BYTES ((word)WORDS_TO_BYTES(DISCARD_WORDS))
916
917 # define OBJ_SZ_TO_BLOCKS(sz) \
918 divHBLKSZ(HDR_BYTES + WORDS_TO_BYTES(sz) + HBLKSIZE-1)
919 /* Size of block (in units of HBLKSIZE) needed to hold objects of */
920 /* given sz (in words). */
921
922 /* Object free list link */
923 # define obj_link(p) (*(ptr_t *)(p))
924
925 /* lists of all heap blocks and free lists */
926 /* These are grouped together in a struct */
927 /* so that they can be easily skipped by the */
928 /* GC_mark routine. */
929 /* The ordering is weird to make GC_malloc */
930 /* faster by keeping the important fields */
931 /* sufficiently close together that a */
932 /* single load of a base register will do. */
933 /* Scalars that could easily appear to */
934 /* be pointers are also put here. */
935 /* The main fields should precede any */
936 /* conditionally included fields, so that */
937 /* gc_inl.h will work even if a different set */
938 /* of macros is defined when the client is */
939 /* compiled. */
940
941 struct _GC_arrays {
942 word _heapsize;
943 word _max_heapsize;
944 ptr_t _last_heap_addr;
945 ptr_t _prev_heap_addr;
946 word _words_allocd_before_gc;
947 /* Number of words allocated before this */
948 /* collection cycle. */
949 word _words_allocd;
950 /* Number of words allocated during this collection cycle */
951 word _words_wasted;
952 /* Number of words wasted due to internal fragmentation */
953 /* in large objects, or due to dropping blacklisted */
954 /* blocks, since last gc. Approximate. */
955 word _words_finalized;
956 /* Approximate number of words in objects (and headers) */
957 /* That became ready for finalization in the last */
958 /* collection. */
959 word _non_gc_bytes_at_gc;
960 /* Number of explicitly managed bytes of storage */
961 /* at last collection. */
962 word _mem_freed;
963 /* Number of explicitly deallocated words of memory */
964 /* since last collection. */
965
966 ptr_t _objfreelist[MAXOBJSZ+1];
967 /* free list for objects */
968 ptr_t _aobjfreelist[MAXOBJSZ+1];
969 /* free list for atomic objs */
970
971 ptr_t _uobjfreelist[MAXOBJSZ+1];
972 /* uncollectable but traced objs */
973 /* objects on this and auobjfreelist */
974 /* are always marked, except during */
975 /* garbage collections. */
976 # ifdef ATOMIC_UNCOLLECTABLE
977 ptr_t _auobjfreelist[MAXOBJSZ+1];
978 # endif
979 /* uncollectable but traced objs */
980
981 # ifdef GATHERSTATS
982 word _composite_in_use;
983 /* Number of words in accessible composite */
984 /* objects. */
985 word _atomic_in_use;
986 /* Number of words in accessible atomic */
987 /* objects. */
988 # endif
989 # ifdef MERGE_SIZES
990 unsigned _size_map[WORDS_TO_BYTES(MAXOBJSZ+1)];
991 /* Number of words to allocate for a given allocation request in */
992 /* bytes. */
993 # endif
994
995 # ifdef STUBBORN_ALLOC
996 ptr_t _sobjfreelist[MAXOBJSZ+1];
997 # endif
998 /* free list for immutable objects */
999 ptr_t _obj_map[MAXOBJSZ+1];
1000 /* If not NIL, then a pointer to a map of valid */
1001 /* object addresses. _obj_map[sz][i] is j if the */
1002 /* address block_start+i is a valid pointer */
1003 /* to an object at */
1004 /* block_start+i&~3 - WORDS_TO_BYTES(j). */
1005 /* (If ALL_INTERIOR_POINTERS is defined, then */
1006 /* instead ((short *)(hbh_map[sz])[i] is j if */
1007 /* block_start+WORDS_TO_BYTES(i) is in the */
1008 /* interior of an object starting at */
1009 /* block_start+WORDS_TO_BYTES(i-j)). */
1010 /* It is OBJ_INVALID if */
1011 /* block_start+WORDS_TO_BYTES(i) is not */
1012 /* valid as a pointer to an object. */
1013 /* We assume all values of j <= OBJ_INVALID. */
1014 /* The zeroth entry corresponds to large objects.*/
1015 # ifdef ALL_INTERIOR_POINTERS
1016 # define map_entry_type short
1017 # define OBJ_INVALID 0x7fff
1018 # define MAP_ENTRY(map, bytes) \
1019 (((map_entry_type *)(map))[BYTES_TO_WORDS(bytes)])
1020 # define MAP_ENTRIES BYTES_TO_WORDS(HBLKSIZE)
1021 # define MAP_SIZE (MAP_ENTRIES * sizeof(map_entry_type))
1022 # define OFFSET_VALID(displ) TRUE
1023 # define CPP_MAX_OFFSET (HBLKSIZE - HDR_BYTES - 1)
1024 # define MAX_OFFSET ((word)CPP_MAX_OFFSET)
1025 # else
1026 # define map_entry_type char
1027 # define OBJ_INVALID 0x7f
1028 # define MAP_ENTRY(map, bytes) \
1029 (map)[bytes]
1030 # define MAP_ENTRIES HBLKSIZE
1031 # define MAP_SIZE MAP_ENTRIES
1032 # define CPP_MAX_OFFSET (WORDS_TO_BYTES(OBJ_INVALID) - 1)
1033 # define MAX_OFFSET ((word)CPP_MAX_OFFSET)
1034 # define VALID_OFFSET_SZ \
1035 (CPP_MAX_OFFSET > WORDS_TO_BYTES(CPP_MAXOBJSZ)? \
1036 CPP_MAX_OFFSET+1 \
1037 : WORDS_TO_BYTES(CPP_MAXOBJSZ)+1)
1038 char _valid_offsets[VALID_OFFSET_SZ];
1039 /* GC_valid_offsets[i] == TRUE ==> i */
1040 /* is registered as a displacement. */
1041 # define OFFSET_VALID(displ) GC_valid_offsets[displ]
1042 char _modws_valid_offsets[sizeof(word)];
1043 /* GC_valid_offsets[i] ==> */
1044 /* GC_modws_valid_offsets[i%sizeof(word)] */
1045 # endif
1046 # ifdef STUBBORN_ALLOC
1047 page_hash_table _changed_pages;
1048 /* Stubborn object pages that were changes since last call to */
1049 /* GC_read_changed. */
1050 page_hash_table _prev_changed_pages;
1051 /* Stubborn object pages that were changes before last call to */
1052 /* GC_read_changed. */
1053 # endif
1054 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
1055 page_hash_table _grungy_pages; /* Pages that were dirty at last */
1056 /* GC_read_dirty. */
1057 # endif
1058 # ifdef LARGE_CONFIG
1059 # if CPP_WORDSZ > 32
1060 # define MAX_HEAP_SECTS 4096 /* overflows at roughly 64 GB */
1061 # else
1062 # define MAX_HEAP_SECTS 768 /* Separately added heap sections. */
1063 # endif
1064 # else
1065 # define MAX_HEAP_SECTS 256
1066 # endif
1067 struct HeapSect {
1068 ptr_t hs_start; word hs_bytes;
1069 } _heap_sects[MAX_HEAP_SECTS];
1070 # ifdef MSWIN32
1071 ptr_t _heap_bases[MAX_HEAP_SECTS];
1072 /* Start address of memory regions obtained from kernel. */
1073 # endif
1074 /* Block header index; see gc_headers.h */
1075 bottom_index * _all_nils;
1076 bottom_index * _top_index [TOP_SZ];
1077 #ifdef SAVE_CALL_CHAIN
1078 struct callinfo _last_stack[NFRAMES]; /* Stack at last garbage collection.*/
1079 /* Useful for debugging mysterious */
1080 /* object disappearances. */
1081 /* In the multithreaded case, we */
1082 /* currently only save the calling */
1083 /* stack. */
1084 #endif
1085 };
1086
1087 GC_API GC_FAR struct _GC_arrays GC_arrays;
1088
1089 # define GC_objfreelist GC_arrays._objfreelist
1090 # define GC_aobjfreelist GC_arrays._aobjfreelist
1091 # define GC_uobjfreelist GC_arrays._uobjfreelist
1092 # ifdef ATOMIC_UNCOLLECTABLE
1093 # define GC_auobjfreelist GC_arrays._auobjfreelist
1094 # endif
1095 # define GC_sobjfreelist GC_arrays._sobjfreelist
1096 # define GC_valid_offsets GC_arrays._valid_offsets
1097 # define GC_modws_valid_offsets GC_arrays._modws_valid_offsets
1098 # ifdef STUBBORN_ALLOC
1099 # define GC_changed_pages GC_arrays._changed_pages
1100 # define GC_prev_changed_pages GC_arrays._prev_changed_pages
1101 # endif
1102 # define GC_obj_map GC_arrays._obj_map
1103 # define GC_last_heap_addr GC_arrays._last_heap_addr
1104 # define GC_prev_heap_addr GC_arrays._prev_heap_addr
1105 # define GC_words_allocd GC_arrays._words_allocd
1106 # define GC_words_wasted GC_arrays._words_wasted
1107 # define GC_words_finalized GC_arrays._words_finalized
1108 # define GC_non_gc_bytes_at_gc GC_arrays._non_gc_bytes_at_gc
1109 # define GC_mem_freed GC_arrays._mem_freed
1110 # define GC_heapsize GC_arrays._heapsize
1111 # define GC_max_heapsize GC_arrays._max_heapsize
1112 # define GC_words_allocd_before_gc GC_arrays._words_allocd_before_gc
1113 # define GC_heap_sects GC_arrays._heap_sects
1114 # define GC_last_stack GC_arrays._last_stack
1115 # ifdef MSWIN32
1116 # define GC_heap_bases GC_arrays._heap_bases
1117 # endif
1118 # define GC_all_nils GC_arrays._all_nils
1119 # define GC_top_index GC_arrays._top_index
1120 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
1121 # define GC_grungy_pages GC_arrays._grungy_pages
1122 # endif
1123 # ifdef GATHERSTATS
1124 # define GC_composite_in_use GC_arrays._composite_in_use
1125 # define GC_atomic_in_use GC_arrays._atomic_in_use
1126 # endif
1127 # ifdef MERGE_SIZES
1128 # define GC_size_map GC_arrays._size_map
1129 # endif
1130
1131 # define beginGC_arrays ((ptr_t)(&GC_arrays))
1132 # define endGC_arrays (((ptr_t)(&GC_arrays)) + (sizeof GC_arrays))
1133
1134 GC_API word GC_fo_entries;
1135
1136 # define MAXOBJKINDS 16
1137
1138 /* Object kinds: */
1139 extern struct obj_kind {
1140 ptr_t *ok_freelist; /* Array of free listheaders for this kind of object */
1141 /* Point either to GC_arrays or to storage allocated */
1142 /* with GC_scratch_alloc. */
1143 struct hblk **ok_reclaim_list;
1144 /* List headers for lists of blocks waiting to be */
1145 /* swept. */
1146 word ok_descriptor; /* Descriptor template for objects in this */
1147 /* block. */
1148 GC_bool ok_relocate_descr;
1149 /* Add object size in bytes to descriptor */
1150 /* template to obtain descriptor. Otherwise */
1151 /* template is used as is. */
1152 GC_bool ok_init; /* Clear objects before putting them on the free list. */
1153 } GC_obj_kinds[MAXOBJKINDS];
1154 /* Predefined kinds: */
1155 # define PTRFREE 0
1156 # define NORMAL 1
1157 # define UNCOLLECTABLE 2
1158 # ifdef ATOMIC_UNCOLLECTABLE
1159 # define AUNCOLLECTABLE 3
1160 # define STUBBORN 4
1161 # define IS_UNCOLLECTABLE(k) (((k) & ~1) == UNCOLLECTABLE)
1162 # else
1163 # define STUBBORN 3
1164 # define IS_UNCOLLECTABLE(k) ((k) == UNCOLLECTABLE)
1165 # endif
1166
1167 extern int GC_n_kinds;
1168
1169 extern word GC_n_heap_sects; /* Number of separately added heap */
1170 /* sections. */
1171
1172 extern word GC_page_size;
1173
1174 # ifdef MSWIN32
1175 extern word GC_n_heap_bases; /* See GC_heap_bases. */
1176 # endif
1177
1178 extern word GC_total_stack_black_listed;
1179 /* Number of bytes on stack blacklist. */
1180
1181 extern word GC_black_list_spacing;
1182 /* Average number of bytes between blacklisted */
1183 /* blocks. Approximate. */
1184 /* Counts only blocks that are */
1185 /* "stack-blacklisted", i.e. that are */
1186 /* problematic in the interior of an object. */
1187
1188 extern char * GC_invalid_map;
1189 /* Pointer to the nowhere valid hblk map */
1190 /* Blocks pointing to this map are free. */
1191
1192 extern struct hblk * GC_hblkfreelist;
1193 /* List of completely empty heap blocks */
1194 /* Linked through hb_next field of */
1195 /* header structure associated with */
1196 /* block. */
1197
1198 extern GC_bool GC_is_initialized; /* GC_init() has been run. */
1199
1200 extern GC_bool GC_objects_are_marked; /* There are marked objects in */
1201 /* the heap. */
1202
1203 extern GC_bool GC_incremental; /* Using incremental/generational collection. */
1204
1205 extern GC_bool GC_dirty_maintained;
1206 /* Dirty bits are being maintained, */
1207 /* either for incremental collection, */
1208 /* or to limit the root set. */
1209
1210 # ifndef PCR
1211 extern ptr_t GC_stackbottom; /* Cool end of user stack */
1212 # endif
1213
1214 extern word GC_root_size; /* Total size of registered root sections */
1215
1216 extern GC_bool GC_debugging_started; /* GC_debug_malloc has been called. */
1217
1218 extern ptr_t GC_least_plausible_heap_addr;
1219 extern ptr_t GC_greatest_plausible_heap_addr;
1220 /* Bounds on the heap. Guaranteed valid */
1221 /* Likely to include future heap expansion. */
1222
1223 /* Operations */
1224 # ifndef abs
1225 # define abs(x) ((x) < 0? (-(x)) : (x))
1226 # endif
1227
1228
1229 /* Marks are in a reserved area in */
1230 /* each heap block. Each word has one mark bit associated */
1231 /* with it. Only those corresponding to the beginning of an */
1232 /* object are used. */
1233
1234
1235 /* Mark bit operations */
1236
1237 /*
1238 * Retrieve, set, clear the mark bit corresponding
1239 * to the nth word in a given heap block.
1240 *
1241 * (Recall that bit n corresponds to object beginning at word n
1242 * relative to the beginning of the block, including unused words)
1243 */
1244
1245 # define mark_bit_from_hdr(hhdr,n) (((hhdr)->hb_marks[divWORDSZ(n)] \
1246 >> (modWORDSZ(n))) & (word)1)
1247 # define set_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1248 |= (word)1 << modWORDSZ(n)
1249
1250 # define clear_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1251 &= ~((word)1 << modWORDSZ(n))
1252
1253 /* Important internal collector routines */
1254
1255 ptr_t GC_approx_sp();
1256
1257 GC_bool GC_should_collect();
1258 #ifdef PRESERVE_LAST
1259 GC_bool GC_in_last_heap_sect(/* ptr_t */);
1260 /* In last added heap section? If so, avoid breaking up. */
1261 #endif
1262 void GC_apply_to_all_blocks(/*fn, client_data*/);
1263 /* Invoke fn(hbp, client_data) for each */
1264 /* allocated heap block. */
1265 struct hblk * GC_next_block(/* struct hblk * h */);
1266 void GC_mark_init();
1267 void GC_clear_marks(); /* Clear mark bits for all heap objects. */
1268 void GC_invalidate_mark_state(); /* Tell the marker that marked */
1269 /* objects may point to unmarked */
1270 /* ones, and roots may point to */
1271 /* unmarked objects. */
1272 /* Reset mark stack. */
1273 void GC_mark_from_mark_stack(); /* Mark from everything on the mark stack. */
1274 /* Return after about one pages worth of */
1275 /* work. */
1276 GC_bool GC_mark_stack_empty();
1277 GC_bool GC_mark_some(); /* Perform about one pages worth of marking */
1278 /* work of whatever kind is needed. Returns */
1279 /* quickly if no collection is in progress. */
1280 /* Return TRUE if mark phase finished. */
1281 void GC_initiate_gc(); /* initiate collection. */
1282 /* If the mark state is invalid, this */
1283 /* becomes full colleection. Otherwise */
1284 /* it's partial. */
1285 void GC_push_all(/*b,t*/); /* Push everything in a range */
1286 /* onto mark stack. */
1287 void GC_push_dirty(/*b,t*/); /* Push all possibly changed */
1288 /* subintervals of [b,t) onto */
1289 /* mark stack. */
1290 #ifndef SMALL_CONFIG
1291 void GC_push_conditional(/* ptr_t b, ptr_t t, GC_bool all*/);
1292 #else
1293 # define GC_push_conditional(b, t, all) GC_push_all(b, t)
1294 #endif
1295 /* Do either of the above, depending */
1296 /* on the third arg. */
1297 void GC_push_all_stack(/*b,t*/); /* As above, but consider */
1298 /* interior pointers as valid */
1299 void GC_push_roots(/* GC_bool all */); /* Push all or dirty roots. */
1300 extern void (*GC_push_other_roots)();
1301 /* Push system or application specific roots */
1302 /* onto the mark stack. In some environments */
1303 /* (e.g. threads environments) this is */
1304 /* predfined to be non-zero. A client supplied */
1305 /* replacement should also call the original */
1306 /* function. */
1307 extern void (*GC_start_call_back)(/* void */);
1308 /* Called at start of full collections. */
1309 /* Not called if 0. Called with allocation */
1310 /* lock held. */
1311 /* 0 by default. */
1312 void GC_push_regs(); /* Push register contents onto mark stack. */
1313 void GC_remark(); /* Mark from all marked objects. Used */
1314 /* only if we had to drop something. */
1315 # if defined(MSWIN32)
1316 void __cdecl GC_push_one();
1317 # else
1318 void GC_push_one(/*p*/); /* If p points to an object, mark it */
1319 /* and push contents on the mark stack */
1320 # endif
1321 void GC_push_one_checked(/*p*/); /* Ditto, omits plausibility test */
1322 void GC_push_marked(/* struct hblk h, hdr * hhdr */);
1323 /* Push contents of all marked objects in h onto */
1324 /* mark stack. */
1325 #ifdef SMALL_CONFIG
1326 # define GC_push_next_marked_dirty(h) GC_push_next_marked(h)
1327 #else
1328 struct hblk * GC_push_next_marked_dirty(/* h */);
1329 /* Invoke GC_push_marked on next dirty block above h. */
1330 /* Return a pointer just past the end of this block. */
1331 #endif /* !SMALL_CONFIG */
1332 struct hblk * GC_push_next_marked(/* h */);
1333 /* Ditto, but also mark from clean pages. */
1334 struct hblk * GC_push_next_marked_uncollectable(/* h */);
1335 /* Ditto, but mark only from uncollectable pages. */
1336 GC_bool GC_stopped_mark(); /* Stop world and mark from all roots */
1337 /* and rescuers. */
1338 void GC_clear_hdr_marks(/* hhdr */); /* Clear the mark bits in a header */
1339 void GC_set_hdr_marks(/* hhdr */); /* Set the mark bits in a header */
1340 void GC_add_roots_inner();
1341 GC_bool GC_is_static_root(/* ptr_t p */);
1342 /* Is the address p in one of the registered static */
1343 /* root sections? */
1344 void GC_register_dynamic_libraries();
1345 /* Add dynamic library data sections to the root set. */
1346
1347 /* Machine dependent startup routines */
1348 ptr_t GC_get_stack_base();
1349 void GC_register_data_segments();
1350
1351 /* Black listing: */
1352 void GC_bl_init();
1353 # ifndef ALL_INTERIOR_POINTERS
1354 void GC_add_to_black_list_normal(/* bits, maybe source */);
1355 /* Register bits as a possible future false */
1356 /* reference from the heap or static data */
1357 # ifdef PRINT_BLACK_LIST
1358 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1359 GC_add_to_black_list_normal(bits, source)
1360 # else
1361 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1362 GC_add_to_black_list_normal(bits)
1363 # endif
1364 # else
1365 # ifdef PRINT_BLACK_LIST
1366 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1367 GC_add_to_black_list_stack(bits, source)
1368 # else
1369 # define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1370 GC_add_to_black_list_stack(bits)
1371 # endif
1372 # endif
1373
1374 void GC_add_to_black_list_stack(/* bits, maybe source */);
1375 struct hblk * GC_is_black_listed(/* h, len */);
1376 /* If there are likely to be false references */
1377 /* to a block starting at h of the indicated */
1378 /* length, then return the next plausible */
1379 /* starting location for h that might avoid */
1380 /* these false references. */
1381 void GC_promote_black_lists();
1382 /* Declare an end to a black listing phase. */
1383 void GC_unpromote_black_lists();
1384 /* Approximately undo the effect of the above. */
1385 /* This actually loses some information, but */
1386 /* only in a reasonably safe way. */
1387 word GC_number_stack_black_listed(/*struct hblk *start, struct hblk *endp1 */);
1388 /* Return the number of (stack) blacklisted */
1389 /* blocks in the range for statistical */
1390 /* purposes. */
1391
1392 ptr_t GC_scratch_alloc(/*bytes*/);
1393 /* GC internal memory allocation for */
1394 /* small objects. Deallocation is not */
1395 /* possible. */
1396
1397 /* Heap block layout maps: */
1398 void GC_invalidate_map(/* hdr */);
1399 /* Remove the object map associated */
1400 /* with the block. This identifies */
1401 /* the block as invalid to the mark */
1402 /* routines. */
1403 GC_bool GC_add_map_entry(/*sz*/);
1404 /* Add a heap block map for objects of */
1405 /* size sz to obj_map. */
1406 /* Return FALSE on failure. */
1407 void GC_register_displacement_inner(/*offset*/);
1408 /* Version of GC_register_displacement */
1409 /* that assumes lock is already held */
1410 /* and signals are already disabled. */
1411
1412 /* hblk allocation: */
1413 void GC_new_hblk(/*size_in_words, kind*/);
1414 /* Allocate a new heap block, and build */
1415 /* a free list in it. */
1416 struct hblk * GC_allochblk(/*size_in_words, kind*/);
1417 /* Allocate a heap block, clear it if */
1418 /* for composite objects, inform */
1419 /* the marker that block is valid */
1420 /* for objects of indicated size. */
1421 /* sz < 0 ==> atomic. */
1422 void GC_freehblk(); /* Deallocate a heap block and mark it */
1423 /* as invalid. */
1424
1425 /* Misc GC: */
1426 void GC_init_inner();
1427 GC_bool GC_expand_hp_inner();
1428 void GC_start_reclaim(/*abort_if_found*/);
1429 /* Restore unmarked objects to free */
1430 /* lists, or (if abort_if_found is */
1431 /* TRUE) report them. */
1432 /* Sweeping of small object pages is */
1433 /* largely deferred. */
1434 void GC_continue_reclaim(/*size, kind*/);
1435 /* Sweep pages of the given size and */
1436 /* kind, as long as possible, and */
1437 /* as long as the corr. free list is */
1438 /* empty. */
1439 void GC_reclaim_or_delete_all();
1440 /* Arrange for all reclaim lists to be */
1441 /* empty. Judiciously choose between */
1442 /* sweeping and discarding each page. */
1443 GC_bool GC_reclaim_all(/* GC_stop_func f*/);
1444 /* Reclaim all blocks. Abort (in a */
1445 /* consistent state) if f returns TRUE. */
1446 GC_bool GC_block_empty(/* hhdr */); /* Block completely unmarked? */
1447 GC_bool GC_never_stop_func(); /* Returns FALSE. */
1448 GC_bool GC_try_to_collect_inner(/* GC_stop_func f */);
1449 /* Collect; caller must have acquired */
1450 /* lock and disabled signals. */
1451 /* Collection is aborted if f returns */
1452 /* TRUE. Returns TRUE if it completes */
1453 /* successfully. */
1454 # define GC_gcollect_inner() \
1455 (void) GC_try_to_collect_inner(GC_never_stop_func)
1456 void GC_finish_collection(); /* Finish collection. Mark bits are */
1457 /* consistent and lock is still held. */
1458 GC_bool GC_collect_or_expand(/* needed_blocks */);
1459 /* Collect or expand heap in an attempt */
1460 /* make the indicated number of free */
1461 /* blocks available. Should be called */
1462 /* until the blocks are available or */
1463 /* until it fails by returning FALSE. */
1464 void GC_init(); /* Initialize collector. */
1465 void GC_collect_a_little_inner(/* int n */);
1466 /* Do n units worth of garbage */
1467 /* collection work, if appropriate. */
1468 /* A unit is an amount appropriate for */
1469 /* HBLKSIZE bytes of allocation. */
1470 ptr_t GC_generic_malloc(/* bytes, kind */);
1471 /* Allocate an object of the given */
1472 /* kind. By default, there are only */
1473 /* a few kinds: composite(pointerfree), */
1474 /* atomic, uncollectable, etc. */
1475 /* We claim it's possible for clever */
1476 /* client code that understands GC */
1477 /* internals to add more, e.g. to */
1478 /* communicate object layout info */
1479 /* to the collector. */
1480 ptr_t GC_generic_malloc_ignore_off_page(/* bytes, kind */);
1481 /* As above, but pointers past the */
1482 /* first page of the resulting object */
1483 /* are ignored. */
1484 ptr_t GC_generic_malloc_inner(/* bytes, kind */);
1485 /* Ditto, but I already hold lock, etc. */
1486 ptr_t GC_generic_malloc_words_small GC_PROTO((size_t words, int kind));
1487 /* As above, but size in units of words */
1488 /* Bypasses MERGE_SIZES. Assumes */
1489 /* words <= MAXOBJSZ. */
1490 ptr_t GC_generic_malloc_inner_ignore_off_page(/* bytes, kind */);
1491 /* Allocate an object, where */
1492 /* the client guarantees that there */
1493 /* will always be a pointer to the */
1494 /* beginning of the object while the */
1495 /* object is live. */
1496 ptr_t GC_allocobj(/* sz_inn_words, kind */);
1497 /* Make the indicated */
1498 /* free list nonempty, and return its */
1499 /* head. */
1500
1501 void GC_init_headers();
1502 GC_bool GC_install_header(/*h*/);
1503 /* Install a header for block h. */
1504 /* Return FALSE on failure. */
1505 GC_bool GC_install_counts(/*h, sz*/);
1506 /* Set up forwarding counts for block */
1507 /* h of size sz. */
1508 /* Return FALSE on failure. */
1509 void GC_remove_header(/*h*/);
1510 /* Remove the header for block h. */
1511 void GC_remove_counts(/*h, sz*/);
1512 /* Remove forwarding counts for h. */
1513 hdr * GC_find_header(/*p*/); /* Debugging only. */
1514
1515 void GC_finalize(); /* Perform all indicated finalization actions */
1516 /* on unmarked objects. */
1517 /* Unreachable finalizable objects are enqueued */
1518 /* for processing by GC_invoke_finalizers. */
1519 /* Invoked with lock. */
1520
1521 void GC_add_to_heap(/*p, bytes*/);
1522 /* Add a HBLKSIZE aligned chunk to the heap. */
1523
1524 void GC_print_obj(/* ptr_t p */);
1525 /* P points to somewhere inside an object with */
1526 /* debugging info. Print a human readable */
1527 /* description of the object to stderr. */
1528 ptr_t GC_debug_object_start(/* ptr_t p */);
1529 /* P points to the start of an object that may */
1530 /* have debug info at its head. Return the */
1531 /* start of the real data. */
1532 extern void (*GC_check_heap)();
1533 /* Check that all objects in the heap with */
1534 /* debugging info are intact. Print */
1535 /* descriptions of any that are not. */
1536 extern void (*GC_print_heap_obj)(/* ptr_t p */);
1537 /* If possible print s followed by a more */
1538 /* detailed description of the object */
1539 /* referred to by p. */
1540
1541 /* Virtual dirty bit implementation: */
1542 /* Each implementation exports the following: */
1543 void GC_read_dirty(); /* Retrieve dirty bits. */
1544 GC_bool GC_page_was_dirty(/* struct hblk * h */);
1545 /* Read retrieved dirty bits. */
1546 GC_bool GC_page_was_ever_dirty(/* struct hblk * h */);
1547 /* Could the page contain valid heap pointers? */
1548 void GC_is_fresh(/* struct hblk * h, word number_of_blocks */);
1549 /* Assert the region currently contains no */
1550 /* valid pointers. */
1551 void GC_write_hint(/* struct hblk * h */);
1552 /* h is about to be written. */
1553 void GC_dirty_init();
1554
1555 /* Slow/general mark bit manipulation: */
1556 GC_bool GC_is_marked();
1557 void GC_clear_mark_bit();
1558 void GC_set_mark_bit();
1559
1560 /* Stubborn objects: */
1561 void GC_read_changed(); /* Analogous to GC_read_dirty */
1562 GC_bool GC_page_was_changed(/* h */); /* Analogous to GC_page_was_dirty */
1563 void GC_clean_changing_list(); /* Collect obsolete changing list entries */
1564 void GC_stubborn_init();
1565
1566 /* Debugging print routines: */
1567 void GC_print_block_list();
1568 void GC_print_hblkfreelist();
1569 void GC_print_heap_sects();
1570 void GC_print_static_roots();
1571 void GC_dump();
1572
1573 /* Make arguments appear live to compiler */
1574 # ifdef __WATCOMC__
1575 void GC_noop(void*, ...);
1576 # else
1577 GC_API void GC_noop();
1578 # endif
1579
1580 void GC_noop1(/* word arg */);
1581
1582 /* Logging and diagnostic output: */
1583 GC_API void GC_printf GC_PROTO((char * format, long, long, long, long, long, long));
1584 /* A version of printf that doesn't allocate, */
1585 /* is restricted to long arguments, and */
1586 /* (unfortunately) doesn't use varargs for */
1587 /* portability. Restricted to 6 args and */
1588 /* 1K total output length. */
1589 /* (We use sprintf. Hopefully that doesn't */
1590 /* allocate for long arguments.) */
1591 # define GC_printf0(f) GC_printf(f, 0l, 0l, 0l, 0l, 0l, 0l)
1592 # define GC_printf1(f,a) GC_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1593 # define GC_printf2(f,a,b) GC_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1594 # define GC_printf3(f,a,b,c) GC_printf(f, (long)a, (long)b, (long)c, 0l, 0l, 0l)
1595 # define GC_printf4(f,a,b,c,d) GC_printf(f, (long)a, (long)b, (long)c, \
1596 (long)d, 0l, 0l)
1597 # define GC_printf5(f,a,b,c,d,e) GC_printf(f, (long)a, (long)b, (long)c, \
1598 (long)d, (long)e, 0l)
1599 # define GC_printf6(f,a,b,c,d,e,g) GC_printf(f, (long)a, (long)b, (long)c, \
1600 (long)d, (long)e, (long)g)
1601
1602 void GC_err_printf(/* format, a, b, c, d, e, f */);
1603 # define GC_err_printf0(f) GC_err_puts(f)
1604 # define GC_err_printf1(f,a) GC_err_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1605 # define GC_err_printf2(f,a,b) GC_err_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1606 # define GC_err_printf3(f,a,b,c) GC_err_printf(f, (long)a, (long)b, (long)c, \
1607 0l, 0l, 0l)
1608 # define GC_err_printf4(f,a,b,c,d) GC_err_printf(f, (long)a, (long)b, \
1609 (long)c, (long)d, 0l, 0l)
1610 # define GC_err_printf5(f,a,b,c,d,e) GC_err_printf(f, (long)a, (long)b, \
1611 (long)c, (long)d, \
1612 (long)e, 0l)
1613 # define GC_err_printf6(f,a,b,c,d,e,g) GC_err_printf(f, (long)a, (long)b, \
1614 (long)c, (long)d, \
1615 (long)e, (long)g)
1616 /* Ditto, writes to stderr. */
1617
1618 void GC_err_puts(/* char *s */);
1619 /* Write s to stderr, don't buffer, don't add */
1620 /* newlines, don't ... */
1621
1622
1623 # endif /* GC_PRIVATE_H */
Mirror of the offical gcc git repository hosted at gcc.gnu.org