OSDN Git Service

2007-01-19 Andreas Tobler <a.tobler@schweiz.org>
[pf3gnuchains/gcc-fork.git] / boehm-gc / include / private / gc_priv.h
1 /* 
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-2001 by Hewlett-Packard Company. All rights reserved.
6  *
7  *
8  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
9  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
10  *
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.
16  */
17  
18
19 # ifndef GC_PRIVATE_H
20 # define GC_PRIVATE_H
21
22 /* Autoconf definitions. */
23 /* FIXME: This should really be included directly from each .c file. */
24 #include <gc_config.h>
25
26 #if defined(mips) && defined(SYSTYPE_BSD) && defined(sony_news)
27     /* sony RISC NEWS, NEWSOS 4 */
28 #   define BSD_TIME
29 /*    typedef long ptrdiff_t;   -- necessary on some really old systems */
30 #endif
31
32 #if defined(mips) && defined(SYSTYPE_BSD43)
33     /* MIPS RISCOS 4 */
34 #   define BSD_TIME
35 #endif
36
37 #ifdef DGUX
38 #   include <sys/types.h>
39 #   include <sys/time.h>
40 #   include <sys/resource.h>
41 #endif /* DGUX */
42
43 #ifdef BSD_TIME
44 #   include <sys/types.h>
45 #   include <sys/time.h>
46 #   include <sys/resource.h>
47 #endif /* BSD_TIME */
48
49 # ifndef _GC_H
50 #   include "../gc.h"
51 # endif
52
53 # ifndef GC_MARK_H
54 #   include "../gc_mark.h"
55 # endif
56
57 typedef GC_word word;
58 typedef GC_signed_word signed_word;
59
60 typedef int GC_bool;
61 # define TRUE 1
62 # define FALSE 0
63
64 typedef char * ptr_t;   /* A generic pointer to which we can add        */
65                         /* byte displacements.                          */
66                         /* Preferably identical to caddr_t, if it       */
67                         /* exists.                                      */
68                         
69 # ifndef GCCONFIG_H
70 #   include "gcconfig.h"
71 # endif
72
73 # ifndef HEADERS_H
74 #   include "gc_hdrs.h"
75 # endif
76
77 #if defined(__STDC__)
78 #   include <stdlib.h>
79 #   if !(defined( sony_news ) )
80 #       include <stddef.h>
81 #   endif
82 #   define VOLATILE volatile
83 #else
84 #   ifdef MSWIN32
85 #       include <stdlib.h>
86 #   endif
87 #   define VOLATILE
88 #endif
89
90 #if 0 /* defined(__GNUC__) doesn't work yet */
91 # define EXPECT(expr, outcome) __builtin_expect(expr,outcome)
92   /* Equivalent to (expr), but predict that usually (expr)==outcome. */
93 #else
94 # define EXPECT(expr, outcome) (expr)
95 #endif /* __GNUC__ */
96
97 # ifndef GC_LOCKS_H
98 #   include "gc_locks.h"
99 # endif
100
101 # ifdef STACK_GROWS_DOWN
102 #   define COOLER_THAN >
103 #   define HOTTER_THAN <
104 #   define MAKE_COOLER(x,y) if ((word)(x)+(y) > (word)(x)) {(x) += (y);} \
105                             else {(x) = (word)ONES;}
106 #   define MAKE_HOTTER(x,y) (x) -= (y)
107 # else
108 #   define COOLER_THAN <
109 #   define HOTTER_THAN >
110 #   define MAKE_COOLER(x,y) if ((word)(x)-(y) < (word)(x)) {(x) -= (y);} else {(x) = 0;}
111 #   define MAKE_HOTTER(x,y) (x) += (y)
112 # endif
113
114 #if defined(AMIGA) && defined(__SASC)
115 #   define GC_FAR __far
116 #else
117 #   define GC_FAR
118 #endif
119
120
121 /*********************************/
122 /*                               */
123 /* Definitions for conservative  */
124 /* collector                     */
125 /*                               */
126 /*********************************/
127
128 /*********************************/
129 /*                               */
130 /* Easily changeable parameters  */
131 /*                               */
132 /*********************************/
133
134 /* #define STUBBORN_ALLOC */
135                     /* Enable stubborm allocation, and thus a limited   */
136                     /* form of incremental collection w/o dirty bits.   */
137
138 /* #define ALL_INTERIOR_POINTERS */
139                     /* Forces all pointers into the interior of an      */
140                     /* object to be considered valid.  Also causes the  */
141                     /* sizes of all objects to be inflated by at least  */
142                     /* one byte.  This should suffice to guarantee      */
143                     /* that in the presence of a compiler that does     */
144                     /* not perform garbage-collector-unsafe             */
145                     /* optimizations, all portable, strictly ANSI       */
146                     /* conforming C programs should be safely usable    */
147                     /* with malloc replaced by GC_malloc and free       */
148                     /* calls removed.  There are several disadvantages: */
149                     /* 1. There are probably no interesting, portable,  */
150                     /*    strictly ANSI conforming C programs.          */
151                     /* 2. This option makes it hard for the collector   */
152                     /*    to allocate space that is not ``pointed to''  */
153                     /*    by integers, etc.  Under SunOS 4.X with a     */
154                     /*    statically linked libc, we empiricaly         */
155                     /*    observed that it would be difficult to        */
156                     /*    allocate individual objects larger than 100K. */
157                     /*    Even if only smaller objects are allocated,   */
158                     /*    more swap space is likely to be needed.       */
159                     /*    Fortunately, much of this will never be       */
160                     /*    touched.                                      */
161                     /* If you can easily avoid using this option, do.   */
162                     /* If not, try to keep individual objects small.    */
163                     /* This is now really controlled at startup,        */
164                     /* through GC_all_interior_pointers.                */
165                     
166 #define PRINTSTATS  /* Print garbage collection statistics              */
167                     /* For less verbose output, undefine in reclaim.c   */
168
169 #define PRINTTIMES  /* Print the amount of time consumed by each garbage   */
170                     /* collection.                                         */
171
172 #define PRINTBLOCKS /* Print object sizes associated with heap blocks,     */
173                     /* whether the objects are atomic or composite, and    */
174                     /* whether or not the block was found to be empty      */
175                     /* during the reclaim phase.  Typically generates       */
176                     /* about one screenful per garbage collection.         */
177 #undef PRINTBLOCKS
178
179 #ifdef SILENT
180 #  ifdef PRINTSTATS
181 #    undef PRINTSTATS
182 #  endif
183 #  ifdef PRINTTIMES
184 #    undef PRINTTIMES
185 #  endif
186 #  ifdef PRINTNBLOCKS
187 #    undef PRINTNBLOCKS
188 #  endif
189 #endif
190
191 #if defined(PRINTSTATS) && !defined(GATHERSTATS)
192 #   define GATHERSTATS
193 #endif
194
195 #if defined(PRINTSTATS) || !defined(SMALL_CONFIG)
196 #   define CONDPRINT  /* Print some things if GC_print_stats is set */
197 #endif
198
199 #define GC_INVOKE_FINALIZERS() GC_notify_or_invoke_finalizers()
200
201 #define MERGE_SIZES /* Round up some object sizes, so that fewer distinct */
202                     /* free lists are actually maintained.  This applies  */
203                     /* only to the top level routines in misc.c, not to   */
204                     /* user generated code that calls GC_allocobj and     */
205                     /* GC_allocaobj directly.                             */
206                     /* Slows down average programs slightly.  May however */
207                     /* substantially reduce fragmentation if allocation   */
208                     /* request sizes are widely scattered.                */
209                     /* May save significant amounts of space for obj_map  */
210                     /* entries.                                           */
211
212 #if defined(USE_MARK_BYTES) && !defined(ALIGN_DOUBLE)
213 #  define ALIGN_DOUBLE
214    /* We use one byte for every 2 words, which doesn't allow for        */
215    /* odd numbered words to have mark bits.                             */
216 #endif
217
218 #if defined(GC_GCJ_SUPPORT) && ALIGNMENT < 8 && !defined(ALIGN_DOUBLE)
219    /* GCJ's Hashtable synchronization code requires 64-bit alignment.  */
220 #  define ALIGN_DOUBLE
221 #endif
222
223 /* ALIGN_DOUBLE requires MERGE_SIZES at present. */
224 # if defined(ALIGN_DOUBLE) && !defined(MERGE_SIZES)
225 #   define MERGE_SIZES
226 # endif
227
228 #if !defined(DONT_ADD_BYTE_AT_END)
229 # define EXTRA_BYTES GC_all_interior_pointers
230 #else
231 # define EXTRA_BYTES 0
232 #endif
233
234
235 # ifndef LARGE_CONFIG
236 #   define MINHINCR 16   /* Minimum heap increment, in blocks of HBLKSIZE  */
237                          /* Must be multiple of largest page size.         */
238 #   define MAXHINCR 2048 /* Maximum heap increment, in blocks              */
239 # else
240 #   define MINHINCR 64
241 #   define MAXHINCR 4096
242 # endif
243
244 # define TIME_LIMIT 50     /* We try to keep pause times from exceeding  */
245                            /* this by much. In milliseconds.             */
246
247 # define BL_LIMIT GC_black_list_spacing
248                            /* If we need a block of N bytes, and we have */
249                            /* a block of N + BL_LIMIT bytes available,   */
250                            /* and N > BL_LIMIT,                          */
251                            /* but all possible positions in it are       */
252                            /* blacklisted, we just use it anyway (and    */
253                            /* print a warning, if warnings are enabled). */
254                            /* This risks subsequently leaking the block  */
255                            /* due to a false reference.  But not using   */
256                            /* the block risks unreasonable immediate     */
257                            /* heap growth.                               */
258
259 /*********************************/
260 /*                               */
261 /* Stack saving for debugging    */
262 /*                               */
263 /*********************************/
264
265 #ifdef NEED_CALLINFO
266     struct callinfo {
267         word ci_pc;     /* Caller, not callee, pc       */
268 #       if NARGS > 0
269             word ci_arg[NARGS]; /* bit-wise complement to avoid retention */
270 #       endif
271 #       if defined(ALIGN_DOUBLE) && (NFRAMES * (NARGS + 1)) % 2 == 1
272             /* Likely alignment problem. */
273             word ci_dummy;
274 #       endif
275     };
276 #endif
277
278 #ifdef SAVE_CALL_CHAIN
279
280 /* Fill in the pc and argument information for up to NFRAMES of my      */
281 /* callers.  Ignore my frame and my callers frame.                      */
282 void GC_save_callers GC_PROTO((struct callinfo info[NFRAMES]));
283   
284 void GC_print_callers GC_PROTO((struct callinfo info[NFRAMES]));
285
286 #endif
287
288
289 /*********************************/
290 /*                               */
291 /* OS interface routines         */
292 /*                               */
293 /*********************************/
294
295 #ifdef BSD_TIME
296 #   undef CLOCK_TYPE
297 #   undef GET_TIME
298 #   undef MS_TIME_DIFF
299 #   define CLOCK_TYPE struct timeval
300 #   define GET_TIME(x) { struct rusage rusage; \
301                          getrusage (RUSAGE_SELF,  &rusage); \
302                          x = rusage.ru_utime; }
303 #   define MS_TIME_DIFF(a,b) ((double) (a.tv_sec - b.tv_sec) * 1000.0 \
304                                + (double) (a.tv_usec - b.tv_usec) / 1000.0)
305 #else /* !BSD_TIME */
306 # if defined(MSWIN32) || defined(MSWINCE)
307 #   include <windows.h>
308 #   include <winbase.h>
309 #   define CLOCK_TYPE DWORD
310 #   define GET_TIME(x) x = GetTickCount()
311 #   define MS_TIME_DIFF(a,b) ((long)((a)-(b)))
312 # else /* !MSWIN32, !MSWINCE, !BSD_TIME */
313 #   include <time.h>
314 #   if !defined(__STDC__) && defined(SPARC) && defined(SUNOS4)
315       clock_t clock();  /* Not in time.h, where it belongs      */
316 #   endif
317 #   if defined(FREEBSD) && !defined(CLOCKS_PER_SEC)
318 #     include <machine/limits.h>
319 #     define CLOCKS_PER_SEC CLK_TCK
320 #   endif
321 #   if !defined(CLOCKS_PER_SEC)
322 #     define CLOCKS_PER_SEC 1000000
323 /*
324  * This is technically a bug in the implementation.  ANSI requires that
325  * CLOCKS_PER_SEC be defined.  But at least under SunOS4.1.1, it isn't.
326  * Also note that the combination of ANSI C and POSIX is incredibly gross
327  * here. The type clock_t is used by both clock() and times().  But on
328  * some machines these use different notions of a clock tick,  CLOCKS_PER_SEC
329  * seems to apply only to clock.  Hence we use it here.  On many machines,
330  * including SunOS, clock actually uses units of microseconds (which are
331  * not really clock ticks).
332  */
333 #   endif
334 #   define CLOCK_TYPE clock_t
335 #   define GET_TIME(x) x = clock()
336 #   define MS_TIME_DIFF(a,b) ((unsigned long) \
337                 (1000.0*(double)((a)-(b))/(double)CLOCKS_PER_SEC))
338 # endif /* !MSWIN32 */
339 #endif /* !BSD_TIME */
340
341 /* We use bzero and bcopy internally.  They may not be available.       */
342 # if defined(SPARC) && defined(SUNOS4)
343 #   define BCOPY_EXISTS
344 # endif
345 # if defined(M68K) && defined(AMIGA)
346 #   define BCOPY_EXISTS
347 # endif
348 # if defined(M68K) && defined(NEXT)
349 #   define BCOPY_EXISTS
350 # endif
351 # if defined(VAX)
352 #   define BCOPY_EXISTS
353 # endif
354 # if defined(AMIGA)
355 #   include <string.h>
356 #   define BCOPY_EXISTS
357 # endif
358 # if defined(DARWIN)
359 #   include <string.h>
360 #   define BCOPY_EXISTS
361 # endif
362
363 # ifndef BCOPY_EXISTS
364 #   include <string.h>
365 #   define BCOPY(x,y,n) memcpy(y, x, (size_t)(n))
366 #   define BZERO(x,n)  memset(x, 0, (size_t)(n))
367 # else
368 #   define BCOPY(x,y,n) bcopy((char *)(x),(char *)(y),(int)(n))
369 #   define BZERO(x,n) bzero((char *)(x),(int)(n))
370 # endif
371
372 /* Delay any interrupts or signals that may abort this thread.  Data    */
373 /* structures are in a consistent state outside this pair of calls.     */
374 /* ANSI C allows both to be empty (though the standard isn't very       */
375 /* clear on that point).  Standard malloc implementations are usually   */
376 /* neither interruptable nor thread-safe, and thus correspond to        */
377 /* empty definitions.                                                   */
378 /* It probably doesn't make any sense to declare these to be nonempty   */
379 /* if the code is being optimized, since signal safety relies on some   */
380 /* ordering constraints that are typically not obeyed by optimizing     */
381 /* compilers.                                                           */
382 # ifdef PCR
383 #   define DISABLE_SIGNALS() \
384                  PCR_Th_SetSigMask(PCR_allSigsBlocked,&GC_old_sig_mask)
385 #   define ENABLE_SIGNALS() \
386                 PCR_Th_SetSigMask(&GC_old_sig_mask, NIL)
387 # else
388 #   if defined(THREADS) || defined(AMIGA)  \
389         || defined(MSWIN32) || defined(MSWINCE) || defined(MACOS) \
390         || defined(DJGPP) || defined(NO_SIGNALS) 
391                         /* Also useful for debugging.           */
392         /* Should probably use thr_sigsetmask for GC_SOLARIS_THREADS. */
393 #     define DISABLE_SIGNALS()
394 #     define ENABLE_SIGNALS()
395 #   else
396 #     define DISABLE_SIGNALS() GC_disable_signals()
397         void GC_disable_signals();
398 #     define ENABLE_SIGNALS() GC_enable_signals()
399         void GC_enable_signals();
400 #   endif
401 # endif
402
403 /*
404  * Stop and restart mutator threads.
405  */
406 # ifdef PCR
407 #     include "th/PCR_ThCtl.h"
408 #     define STOP_WORLD() \
409         PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_stopNormal, \
410                                    PCR_allSigsBlocked, \
411                                    PCR_waitForever)
412 #     define START_WORLD() \
413         PCR_ThCtl_SetExclusiveMode(PCR_ThCtl_ExclusiveMode_null, \
414                                    PCR_allSigsBlocked, \
415                                    PCR_waitForever);
416 # else
417 #   if defined(GC_SOLARIS_THREADS) || defined(GC_WIN32_THREADS) \
418         || defined(GC_PTHREADS)
419       void GC_stop_world();
420       void GC_start_world();
421 #     define STOP_WORLD() GC_stop_world()
422 #     define START_WORLD() GC_start_world()
423 #   else
424 #     define STOP_WORLD()
425 #     define START_WORLD()
426 #   endif
427 # endif
428
429 /* Abandon ship */
430 # ifdef PCR
431 #   define ABORT(s) PCR_Base_Panic(s)
432 # else
433 #   ifdef SMALL_CONFIG
434 #       define ABORT(msg) abort();
435 #   else
436         GC_API void GC_abort GC_PROTO((GC_CONST char * msg));
437 #       define ABORT(msg) GC_abort(msg);
438 #   endif
439 # endif
440
441 /* Exit abnormally, but without making a mess (e.g. out of memory) */
442 # ifdef PCR
443 #   define EXIT() PCR_Base_Exit(1,PCR_waitForever)
444 # else
445 #   define EXIT() (void)exit(1)
446 # endif
447
448 /* Print warning message, e.g. almost out of memory.    */
449 # define WARN(msg,arg) (*GC_current_warn_proc)("GC Warning: " msg, (GC_word)(arg))
450 extern GC_warn_proc GC_current_warn_proc;
451
452 /* Get environment entry */
453 #if !defined(NO_GETENV)
454 #   if defined(EMPTY_GETENV_RESULTS)
455         /* Workaround for a reputed Wine bug.   */
456         static inline char * fixed_getenv(const char *name)
457         {
458           char * tmp = getenv(name);
459           if (tmp == 0 || strlen(tmp) == 0)
460             return 0;
461           return tmp;
462         }
463 #       define GETENV(name) fixed_getenv(name)
464 #   else
465 #       define GETENV(name) getenv(name)
466 #   endif
467 #else
468 #   define GETENV(name) 0
469 #endif
470
471 #if defined(DARWIN)
472 #      if defined(POWERPC)
473 #              if CPP_WORDSZ == 32
474 #                define GC_THREAD_STATE_T ppc_thread_state_t
475 #                 define GC_MACH_THREAD_STATE PPC_THREAD_STATE
476 #                 define GC_MACH_THREAD_STATE_COUNT PPC_THREAD_STATE_COUNT
477 #                define GC_MACH_HEADER mach_header
478 #                define GC_MACH_SECTION section
479 #              else
480 #                define GC_THREAD_STATE_T ppc_thread_state64_t
481 #                 define GC_MACH_THREAD_STATE PPC_THREAD_STATE64
482 #                 define GC_MACH_THREAD_STATE_COUNT PPC_THREAD_STATE64_COUNT
483 #                define GC_MACH_HEADER mach_header_64
484 #                define GC_MACH_SECTION section_64
485 #              endif
486 #      elif defined(I386) || defined(X86_64)
487 #              if CPP_WORDSZ == 32
488 #                define GC_THREAD_STATE_T x86_thread_state32_t
489 #                define GC_MACH_THREAD_STATE x86_THREAD_STATE32
490 #                define GC_MACH_THREAD_STATE_COUNT x86_THREAD_STATE32_COUNT
491 #                define GC_MACH_HEADER mach_header
492 #                define GC_MACH_SECTION section
493 #              else
494 #                define GC_THREAD_STATE_T x86_thread_state64_t
495 #                define GC_MACH_THREAD_STATE x86_THREAD_STATE64
496 #                define GC_MACH_THREAD_STATE_COUNT x86_THREAD_STATE64_COUNT
497 #                define GC_MACH_HEADER mach_header_64
498 #                define GC_MACH_SECTION section_64
499 #              endif
500 #      else
501 #              error define GC_THREAD_STATE_T
502 #              define GC_MACH_THREAD_STATE MACHINE_THREAD_STATE
503 #              define GC_MACH_THREAD_STATE_COUNT MACHINE_THREAD_STATE_COUNT
504 #      endif
505 /* Try to work out the right way to access thread state structure members.
506    The structure has changed its definition in different Darwin versions.
507    This now defaults to the (older) names without __, thus hopefully,
508    not breaking any existing Makefile.direct builds.  */
509 #      if defined (HAS_PPC_THREAD_STATE___R0) \
510          || defined (HAS_PPC_THREAD_STATE64___R0) \
511          || defined (HAS_X86_THREAD_STATE32___EAX) \
512          || defined (HAS_X86_THREAD_STATE64___RAX)
513 #        define THREAD_FLD(x) __ ## x
514 #      else
515 #        define THREAD_FLD(x) x
516 #      endif
517 #endif
518 /*********************************/
519 /*                               */
520 /* Word-size-dependent defines   */
521 /*                               */
522 /*********************************/
523
524 #if CPP_WORDSZ == 32
525 #  define WORDS_TO_BYTES(x)   ((x)<<2)
526 #  define BYTES_TO_WORDS(x)   ((x)>>2)
527 #  define LOGWL               ((word)5)    /* log[2] of CPP_WORDSZ */
528 #  define modWORDSZ(n) ((n) & 0x1f)        /* n mod size of word            */
529 #  if ALIGNMENT != 4
530 #       define UNALIGNED
531 #  endif
532 #endif
533
534 #if CPP_WORDSZ == 64
535 #  define WORDS_TO_BYTES(x)   ((x)<<3)
536 #  define BYTES_TO_WORDS(x)   ((x)>>3)
537 #  define LOGWL               ((word)6)    /* log[2] of CPP_WORDSZ */
538 #  define modWORDSZ(n) ((n) & 0x3f)        /* n mod size of word            */
539 #  if ALIGNMENT != 8
540 #       define UNALIGNED
541 #  endif
542 #endif
543
544 #define WORDSZ ((word)CPP_WORDSZ)
545 #define SIGNB  ((word)1 << (WORDSZ-1))
546 #define BYTES_PER_WORD      ((word)(sizeof (word)))
547 #define ONES                ((word)(signed_word)(-1))
548 #define divWORDSZ(n) ((n) >> LOGWL)        /* divide n by size of word      */
549
550 /*********************/
551 /*                   */
552 /*  Size Parameters  */
553 /*                   */
554 /*********************/
555
556 /*  heap block size, bytes. Should be power of 2 */
557
558 #ifndef HBLKSIZE
559 # ifdef SMALL_CONFIG
560 #   define CPP_LOG_HBLKSIZE 10
561 # else
562 #   if (CPP_WORDSZ == 32) || (defined(HPUX) && defined(HP_PA))
563       /* HPUX/PA seems to use 4K pages with the 64 bit ABI */
564 #     define CPP_LOG_HBLKSIZE 12
565 #   else
566 #     define CPP_LOG_HBLKSIZE 13
567 #   endif
568 # endif
569 #else
570 # if HBLKSIZE == 512
571 #   define CPP_LOG_HBLKSIZE 9
572 # endif
573 # if HBLKSIZE == 1024
574 #   define CPP_LOG_HBLKSIZE 10
575 # endif
576 # if HBLKSIZE == 2048
577 #   define CPP_LOG_HBLKSIZE 11
578 # endif
579 # if HBLKSIZE == 4096
580 #   define CPP_LOG_HBLKSIZE 12
581 # endif
582 # if HBLKSIZE == 8192
583 #   define CPP_LOG_HBLKSIZE 13
584 # endif
585 # if HBLKSIZE == 16384
586 #   define CPP_LOG_HBLKSIZE 14
587 # endif
588 # ifndef CPP_LOG_HBLKSIZE
589     --> fix HBLKSIZE
590 # endif
591 # undef HBLKSIZE
592 #endif
593 # define CPP_HBLKSIZE (1 << CPP_LOG_HBLKSIZE)
594 # define LOG_HBLKSIZE   ((word)CPP_LOG_HBLKSIZE)
595 # define HBLKSIZE ((word)CPP_HBLKSIZE)
596
597
598 /*  max size objects supported by freelist (larger objects may be   */
599 /*  allocated, but less efficiently)                                */
600
601 #define CPP_MAXOBJBYTES (CPP_HBLKSIZE/2)
602 #define MAXOBJBYTES ((word)CPP_MAXOBJBYTES)
603 #define CPP_MAXOBJSZ    BYTES_TO_WORDS(CPP_MAXOBJBYTES)
604 #define MAXOBJSZ ((word)CPP_MAXOBJSZ)
605                 
606 # define divHBLKSZ(n) ((n) >> LOG_HBLKSIZE)
607
608 # define HBLK_PTR_DIFF(p,q) divHBLKSZ((ptr_t)p - (ptr_t)q)
609         /* Equivalent to subtracting 2 hblk pointers.   */
610         /* We do it this way because a compiler should  */
611         /* find it hard to use an integer division      */
612         /* instead of a shift.  The bundled SunOS 4.1   */
613         /* o.w. sometimes pessimizes the subtraction to */
614         /* involve a call to .div.                      */
615  
616 # define modHBLKSZ(n) ((n) & (HBLKSIZE-1))
617  
618 # define HBLKPTR(objptr) ((struct hblk *)(((word) (objptr)) & ~(HBLKSIZE-1)))
619
620 # define HBLKDISPL(objptr) (((word) (objptr)) & (HBLKSIZE-1))
621
622 /* Round up byte allocation requests to integral number of words, etc. */
623 # define ROUNDED_UP_WORDS(n) \
624         BYTES_TO_WORDS((n) + (WORDS_TO_BYTES(1) - 1 + EXTRA_BYTES))
625 # ifdef ALIGN_DOUBLE
626 #       define ALIGNED_WORDS(n) \
627             (BYTES_TO_WORDS((n) + WORDS_TO_BYTES(2) - 1 + EXTRA_BYTES) & ~1)
628 # else
629 #       define ALIGNED_WORDS(n) ROUNDED_UP_WORDS(n)
630 # endif
631 # define SMALL_OBJ(bytes) ((bytes) <= (MAXOBJBYTES - EXTRA_BYTES))
632 # define ADD_SLOP(bytes) ((bytes) + EXTRA_BYTES)
633 # ifndef MIN_WORDS
634     /* MIN_WORDS is the size of the smallest allocated object.  */
635     /* 1 and 2 are the only valid values.                       */
636     /* 2 must be used if:                                       */
637     /* - GC_gcj_malloc can be used for objects of requested     */
638     /*   size  smaller than 2 words, or                         */
639     /* - USE_MARK_BYTES is defined.                             */
640 #   if defined(USE_MARK_BYTES) || defined(GC_GCJ_SUPPORT)
641 #     define MIN_WORDS 2        /* Smallest allocated object.   */
642 #   else
643 #     define MIN_WORDS 1
644 #   endif
645 # endif
646
647
648 /*
649  * Hash table representation of sets of pages.  This assumes it is
650  * OK to add spurious entries to sets.
651  * Used by black-listing code, and perhaps by dirty bit maintenance code.
652  */
653  
654 # ifdef LARGE_CONFIG
655 #   define LOG_PHT_ENTRIES  20  /* Collisions likely at 1M blocks,      */
656                                 /* which is >= 4GB.  Each table takes   */
657                                 /* 128KB, some of which may never be    */
658                                 /* touched.                             */
659 # else
660 #   ifdef SMALL_CONFIG
661 #     define LOG_PHT_ENTRIES  14 /* Collisions are likely if heap grows */
662                                  /* to more than 16K hblks = 64MB.      */
663                                  /* Each hash table occupies 2K bytes.   */
664 #   else /* default "medium" configuration */
665 #     define LOG_PHT_ENTRIES  16 /* Collisions are likely if heap grows */
666                                  /* to more than 64K hblks >= 256MB.    */
667                                  /* Each hash table occupies 8K bytes.  */
668                                  /* Even for somewhat smaller heaps,    */
669                                  /* say half that, collisions may be an */
670                                  /* issue because we blacklist          */
671                                  /* addresses outside the heap.         */
672 #   endif
673 # endif
674 # define PHT_ENTRIES ((word)1 << LOG_PHT_ENTRIES)
675 # define PHT_SIZE (PHT_ENTRIES >> LOGWL)
676 typedef word page_hash_table[PHT_SIZE];
677
678 # define PHT_HASH(addr) ((((word)(addr)) >> LOG_HBLKSIZE) & (PHT_ENTRIES - 1))
679
680 # define get_pht_entry_from_index(bl, index) \
681                 (((bl)[divWORDSZ(index)] >> modWORDSZ(index)) & 1)
682 # define set_pht_entry_from_index(bl, index) \
683                 (bl)[divWORDSZ(index)] |= (word)1 << modWORDSZ(index)
684 # define clear_pht_entry_from_index(bl, index) \
685                 (bl)[divWORDSZ(index)] &= ~((word)1 << modWORDSZ(index))
686 /* And a dumb but thread-safe version of set_pht_entry_from_index.      */
687 /* This sets (many) extra bits.                                         */
688 # define set_pht_entry_from_index_safe(bl, index) \
689                 (bl)[divWORDSZ(index)] = ONES
690         
691
692
693 /********************************************/
694 /*                                          */
695 /*    H e a p   B l o c k s                 */
696 /*                                          */
697 /********************************************/
698
699 /*  heap block header */
700 #define HBLKMASK   (HBLKSIZE-1)
701
702 #define BITS_PER_HBLK (CPP_HBLKSIZE * 8)
703
704 #define MARK_BITS_PER_HBLK (BITS_PER_HBLK/CPP_WORDSZ)
705            /* upper bound                                    */
706            /* We allocate 1 bit/word, unless USE_MARK_BYTES  */
707            /* is defined.  Only the first word               */
708            /* in each object is actually marked.             */
709
710 # ifdef USE_MARK_BYTES
711 #   define MARK_BITS_SZ (MARK_BITS_PER_HBLK/2)
712         /* Unlike the other case, this is in units of bytes.            */
713         /* We actually allocate only every second mark bit, since we    */
714         /* force all objects to be doubleword aligned.                  */
715         /* However, each mark bit is allocated as a byte.               */
716 # else
717 #   define MARK_BITS_SZ (MARK_BITS_PER_HBLK/CPP_WORDSZ)
718 # endif
719
720 /* We maintain layout maps for heap blocks containing objects of a given */
721 /* size.  Each entry in this map describes a byte offset and has the     */
722 /* following type.                                                       */
723 typedef unsigned char map_entry_type;
724
725 struct hblkhdr {
726     word hb_sz;  /* If in use, size in words, of objects in the block. */
727                  /* if free, the size in bytes of the whole block      */
728     struct hblk * hb_next;      /* Link field for hblk free list         */
729                                 /* and for lists of chunks waiting to be */
730                                 /* reclaimed.                            */
731     struct hblk * hb_prev;      /* Backwards link for free list.        */
732     word hb_descr;              /* object descriptor for marking.  See  */
733                                 /* mark.h.                              */
734     map_entry_type * hb_map;    
735                         /* A pointer to a pointer validity map of the block. */
736                         /* See GC_obj_map.                                   */
737                         /* Valid for all blocks with headers.                */
738                         /* Free blocks point to GC_invalid_map.              */
739     unsigned char hb_obj_kind;
740                          /* Kind of objects in the block.  Each kind    */
741                          /* identifies a mark procedure and a set of    */
742                          /* list headers.  Sometimes called regions.    */
743     unsigned char hb_flags;
744 #       define IGNORE_OFF_PAGE  1       /* Ignore pointers that do not  */
745                                         /* point to the first page of   */
746                                         /* this object.                 */
747 #       define WAS_UNMAPPED 2   /* This is a free block, which has      */
748                                 /* been unmapped from the address       */
749                                 /* space.                               */
750                                 /* GC_remap must be invoked on it       */
751                                 /* before it can be reallocated.        */
752                                 /* Only set with USE_MUNMAP.            */
753     unsigned short hb_last_reclaimed;
754                                 /* Value of GC_gc_no when block was     */
755                                 /* last allocated or swept. May wrap.   */
756                                 /* For a free block, this is maintained */
757                                 /* only for USE_MUNMAP, and indicates   */
758                                 /* when the header was allocated, or    */
759                                 /* when the size of the block last      */
760                                 /* changed.                             */
761 #   ifdef USE_MARK_BYTES
762       union {
763         char _hb_marks[MARK_BITS_SZ];
764                             /* The i'th byte is 1 if the object         */
765                             /* starting at word 2i is marked, 0 o.w.    */
766         word dummy;     /* Force word alignment of mark bytes. */
767       } _mark_byte_union;
768 #     define hb_marks _mark_byte_union._hb_marks
769 #   else
770       word hb_marks[MARK_BITS_SZ];
771                             /* Bit i in the array refers to the             */
772                             /* object starting at the ith word (header      */
773                             /* INCLUDED) in the heap block.                 */
774                             /* The lsb of word 0 is numbered 0.             */
775                             /* Unused bits are invalid, and are             */
776                             /* occasionally set, e.g for uncollectable      */
777                             /* objects.                                     */
778 #   endif /* !USE_MARK_BYTES */
779 };
780
781 /*  heap block body */
782
783 # define BODY_SZ (HBLKSIZE/sizeof(word))
784
785 struct hblk {
786     word hb_body[BODY_SZ];
787 };
788
789 # define HBLK_IS_FREE(hdr) ((hdr) -> hb_map == GC_invalid_map)
790
791 # define OBJ_SZ_TO_BLOCKS(sz) \
792     divHBLKSZ(WORDS_TO_BYTES(sz) + HBLKSIZE-1)
793     /* Size of block (in units of HBLKSIZE) needed to hold objects of   */
794     /* given sz (in words).                                             */
795
796 /* Object free list link */
797 # define obj_link(p) (*(ptr_t *)(p))
798
799 # define LOG_MAX_MARK_PROCS 6
800 # define MAX_MARK_PROCS (1 << LOG_MAX_MARK_PROCS)
801
802 /* Root sets.  Logically private to mark_rts.c.  But we don't want the  */
803 /* tables scanned, so we put them here.                                 */
804 /* MAX_ROOT_SETS is the maximum number of ranges that can be    */
805 /* registered as static roots.                                  */
806 # ifdef LARGE_CONFIG
807 #   define MAX_ROOT_SETS 4096
808 # else
809     /* GCJ LOCAL: MAX_ROOT_SETS increased to permit more shared */
810     /* libraries to be loaded.                                  */ 
811 #   define MAX_ROOT_SETS 1024
812 # endif
813
814 # define MAX_EXCLUSIONS (MAX_ROOT_SETS/4)
815 /* Maximum number of segments that can be excluded from root sets.      */
816
817 /*
818  * Data structure for excluded static roots.
819  */
820 struct exclusion {
821     ptr_t e_start;
822     ptr_t e_end;
823 };
824
825 /* Data structure for list of root sets.                                */
826 /* We keep a hash table, so that we can filter out duplicate additions. */
827 /* Under Win32, we need to do a better job of filtering overlaps, so    */
828 /* we resort to sequential search, and pay the price.                   */
829 struct roots {
830         ptr_t r_start;
831         ptr_t r_end;
832 #       if !defined(MSWIN32) && !defined(MSWINCE)
833           struct roots * r_next;
834 #       endif
835         GC_bool r_tmp;
836                 /* Delete before registering new dynamic libraries */
837 };
838
839 #if !defined(MSWIN32) && !defined(MSWINCE)
840     /* Size of hash table index to roots.       */
841 #   define LOG_RT_SIZE 6
842 #   define RT_SIZE (1 << LOG_RT_SIZE) /* Power of 2, may be != MAX_ROOT_SETS */
843 #endif
844
845 /* Lists of all heap blocks and free lists      */
846 /* as well as other random data structures      */
847 /* that should not be scanned by the            */
848 /* collector.                                   */
849 /* These are grouped together in a struct       */
850 /* so that they can be easily skipped by the    */
851 /* GC_mark routine.                             */
852 /* The ordering is weird to make GC_malloc      */
853 /* faster by keeping the important fields       */
854 /* sufficiently close together that a           */
855 /* single load of a base register will do.      */
856 /* Scalars that could easily appear to          */
857 /* be pointers are also put here.               */
858 /* The main fields should precede any           */
859 /* conditionally included fields, so that       */
860 /* gc_inl.h will work even if a different set   */
861 /* of macros is defined when the client is      */
862 /* compiled.                                    */
863
864 struct _GC_arrays {
865   word _heapsize;
866   word _max_heapsize;
867   word _requested_heapsize;     /* Heap size due to explicit expansion */
868   ptr_t _last_heap_addr;
869   ptr_t _prev_heap_addr;
870   word _large_free_bytes;
871         /* Total bytes contained in blocks on large object free */
872         /* list.                                                */
873   word _large_allocd_bytes;
874         /* Total number of bytes in allocated large objects blocks.     */
875         /* For the purposes of this counter and the next one only, a    */
876         /* large object is one that occupies a block of at least        */
877         /* 2*HBLKSIZE.                                                  */
878   word _max_large_allocd_bytes;
879         /* Maximum number of bytes that were ever allocated in          */
880         /* large object blocks.  This is used to help decide when it    */
881         /* is safe to split up a large block.                           */
882   word _words_allocd_before_gc;
883                 /* Number of words allocated before this        */
884                 /* collection cycle.                            */
885 # ifndef SEPARATE_GLOBALS
886     word _words_allocd;
887         /* Number of words allocated during this collection cycle */
888 # endif
889   word _words_wasted;
890         /* Number of words wasted due to internal fragmentation */
891         /* in large objects, or due to dropping blacklisted     */
892         /* blocks, since last gc.  Approximate.                 */
893   word _words_finalized;
894         /* Approximate number of words in objects (and headers) */
895         /* That became ready for finalization in the last       */
896         /* collection.                                          */
897   word _non_gc_bytes_at_gc;
898         /* Number of explicitly managed bytes of storage        */
899         /* at last collection.                                  */
900   word _mem_freed;
901         /* Number of explicitly deallocated words of memory     */
902         /* since last collection.                               */
903   word _finalizer_mem_freed;
904         /* Words of memory explicitly deallocated while         */
905         /* finalizers were running.  Used to approximate mem.   */
906         /* explicitly deallocated by finalizers.                */
907   ptr_t _scratch_end_ptr;
908   ptr_t _scratch_last_end_ptr;
909         /* Used by headers.c, and can easily appear to point to */
910         /* heap.                                                */
911   GC_mark_proc _mark_procs[MAX_MARK_PROCS];
912         /* Table of user-defined mark procedures.  There is     */
913         /* a small number of these, which can be referenced     */
914         /* by DS_PROC mark descriptors.  See gc_mark.h.         */
915
916 # ifndef SEPARATE_GLOBALS
917     ptr_t _objfreelist[MAXOBJSZ+1];
918                           /* free list for objects */
919     ptr_t _aobjfreelist[MAXOBJSZ+1];
920                           /* free list for atomic objs  */
921 # endif
922
923   ptr_t _uobjfreelist[MAXOBJSZ+1];
924                           /* uncollectable but traced objs      */
925                           /* objects on this and auobjfreelist  */
926                           /* are always marked, except during   */
927                           /* garbage collections.               */
928 # ifdef ATOMIC_UNCOLLECTABLE
929     ptr_t _auobjfreelist[MAXOBJSZ+1];
930 # endif
931                           /* uncollectable but traced objs      */
932
933 # ifdef GATHERSTATS
934     word _composite_in_use;
935                 /* Number of words in accessible composite      */
936                 /* objects.                                     */
937     word _atomic_in_use;
938                 /* Number of words in accessible atomic         */
939                 /* objects.                                     */
940 # endif
941 # ifdef USE_MUNMAP
942     word _unmapped_bytes;
943 # endif
944 # ifdef MERGE_SIZES
945     unsigned _size_map[WORDS_TO_BYTES(MAXOBJSZ+1)];
946         /* Number of words to allocate for a given allocation request in */
947         /* bytes.                                                        */
948 # endif 
949
950 # ifdef STUBBORN_ALLOC
951     ptr_t _sobjfreelist[MAXOBJSZ+1];
952 # endif
953                           /* free list for immutable objects    */
954   map_entry_type * _obj_map[MAXOBJSZ+1];
955                        /* If not NIL, then a pointer to a map of valid  */
956                        /* object addresses. _obj_map[sz][i] is j if the */
957                        /* address block_start+i is a valid pointer      */
958                        /* to an object at block_start +                 */
959                        /* WORDS_TO_BYTES(BYTES_TO_WORDS(i) - j)         */
960                        /* I.e. j is a word displacement from the        */
961                        /* object beginning.                             */
962                        /* The entry is OBJ_INVALID if the corresponding */
963                        /* address is not a valid pointer.  It is        */
964                        /* OFFSET_TOO_BIG if the value j would be too    */
965                        /* large to fit in the entry.  (Note that the    */
966                        /* size of these entries matters, both for       */
967                        /* space consumption and for cache utilization.) */
968 #   define OFFSET_TOO_BIG 0xfe
969 #   define OBJ_INVALID 0xff
970 #   define MAP_ENTRY(map, bytes) (map)[bytes]
971 #   define MAP_ENTRIES HBLKSIZE
972 #   define MAP_SIZE MAP_ENTRIES
973 #   define CPP_MAX_OFFSET (OFFSET_TOO_BIG - 1)  
974 #   define MAX_OFFSET ((word)CPP_MAX_OFFSET)
975     /* The following are used only if GC_all_interior_ptrs != 0 */
976 #       define VALID_OFFSET_SZ \
977           (CPP_MAX_OFFSET > WORDS_TO_BYTES(CPP_MAXOBJSZ)? \
978            CPP_MAX_OFFSET+1 \
979            : WORDS_TO_BYTES(CPP_MAXOBJSZ)+1)
980         char _valid_offsets[VALID_OFFSET_SZ];
981                                 /* GC_valid_offsets[i] == TRUE ==> i    */
982                                 /* is registered as a displacement.     */
983         char _modws_valid_offsets[sizeof(word)];
984                                 /* GC_valid_offsets[i] ==>                */
985                                 /* GC_modws_valid_offsets[i%sizeof(word)] */
986 #   define OFFSET_VALID(displ) \
987           (GC_all_interior_pointers || GC_valid_offsets[displ])
988 # ifdef STUBBORN_ALLOC
989     page_hash_table _changed_pages;
990         /* Stubborn object pages that were changes since last call to   */
991         /* GC_read_changed.                                             */
992     page_hash_table _prev_changed_pages;
993         /* Stubborn object pages that were changes before last call to  */
994         /* GC_read_changed.                                             */
995 # endif
996 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
997     page_hash_table _grungy_pages; /* Pages that were dirty at last        */
998                                      /* GC_read_dirty.                     */
999 # endif
1000 # ifdef MPROTECT_VDB
1001     VOLATILE page_hash_table _dirty_pages;      
1002                         /* Pages dirtied since last GC_read_dirty. */
1003 # endif
1004 # ifdef PROC_VDB
1005     page_hash_table _written_pages;     /* Pages ever dirtied   */
1006 # endif
1007 # ifdef LARGE_CONFIG
1008 #   if CPP_WORDSZ > 32
1009 #     define MAX_HEAP_SECTS 4096        /* overflows at roughly 64 GB      */
1010 #   else
1011 #     define MAX_HEAP_SECTS 768         /* Separately added heap sections. */
1012 #   endif
1013 # else
1014 #   ifdef SMALL_CONFIG
1015 #     define MAX_HEAP_SECTS 128         /* Roughly 256MB (128*2048*1K)  */
1016 #   else
1017 #     define MAX_HEAP_SECTS 384         /* Roughly 3GB                  */
1018 #   endif
1019 # endif
1020   struct HeapSect {
1021       ptr_t hs_start; word hs_bytes;
1022   } _heap_sects[MAX_HEAP_SECTS];
1023 # if defined(MSWIN32) || defined(MSWINCE)
1024     ptr_t _heap_bases[MAX_HEAP_SECTS];
1025                 /* Start address of memory regions obtained from kernel. */
1026 # endif
1027 # ifdef MSWINCE
1028     word _heap_lengths[MAX_HEAP_SECTS];
1029                 /* Commited lengths of memory regions obtained from kernel. */
1030 # endif
1031   struct roots _static_roots[MAX_ROOT_SETS];
1032 # if !defined(MSWIN32) && !defined(MSWINCE)
1033     struct roots * _root_index[RT_SIZE];
1034 # endif
1035   struct exclusion _excl_table[MAX_EXCLUSIONS];
1036   /* Block header index; see gc_headers.h */
1037   bottom_index * _all_nils;
1038   bottom_index * _top_index [TOP_SZ];
1039 #ifdef SAVE_CALL_CHAIN
1040   struct callinfo _last_stack[NFRAMES]; /* Stack at last garbage collection.*/
1041                                         /* Useful for debugging mysterious  */
1042                                         /* object disappearances.           */
1043                                         /* In the multithreaded case, we    */
1044                                         /* currently only save the calling  */
1045                                         /* stack.                           */
1046 #endif
1047 };
1048
1049 GC_API GC_FAR struct _GC_arrays GC_arrays; 
1050
1051 # ifndef SEPARATE_GLOBALS
1052 #   define GC_objfreelist GC_arrays._objfreelist
1053 #   define GC_aobjfreelist GC_arrays._aobjfreelist
1054 #   define GC_words_allocd GC_arrays._words_allocd
1055 # endif
1056 # define GC_uobjfreelist GC_arrays._uobjfreelist
1057 # ifdef ATOMIC_UNCOLLECTABLE
1058 #   define GC_auobjfreelist GC_arrays._auobjfreelist
1059 # endif
1060 # define GC_sobjfreelist GC_arrays._sobjfreelist
1061 # define GC_valid_offsets GC_arrays._valid_offsets
1062 # define GC_modws_valid_offsets GC_arrays._modws_valid_offsets
1063 # ifdef STUBBORN_ALLOC
1064 #    define GC_changed_pages GC_arrays._changed_pages
1065 #    define GC_prev_changed_pages GC_arrays._prev_changed_pages
1066 # endif
1067 # define GC_obj_map GC_arrays._obj_map
1068 # define GC_last_heap_addr GC_arrays._last_heap_addr
1069 # define GC_prev_heap_addr GC_arrays._prev_heap_addr
1070 # define GC_words_wasted GC_arrays._words_wasted
1071 # define GC_large_free_bytes GC_arrays._large_free_bytes
1072 # define GC_large_allocd_bytes GC_arrays._large_allocd_bytes
1073 # define GC_max_large_allocd_bytes GC_arrays._max_large_allocd_bytes
1074 # define GC_words_finalized GC_arrays._words_finalized
1075 # define GC_non_gc_bytes_at_gc GC_arrays._non_gc_bytes_at_gc
1076 # define GC_mem_freed GC_arrays._mem_freed
1077 # define GC_finalizer_mem_freed GC_arrays._finalizer_mem_freed
1078 # define GC_scratch_end_ptr GC_arrays._scratch_end_ptr
1079 # define GC_scratch_last_end_ptr GC_arrays._scratch_last_end_ptr
1080 # define GC_mark_procs GC_arrays._mark_procs
1081 # define GC_heapsize GC_arrays._heapsize
1082 # define GC_max_heapsize GC_arrays._max_heapsize
1083 # define GC_requested_heapsize GC_arrays._requested_heapsize
1084 # define GC_words_allocd_before_gc GC_arrays._words_allocd_before_gc
1085 # define GC_heap_sects GC_arrays._heap_sects
1086 # define GC_last_stack GC_arrays._last_stack
1087 # ifdef USE_MUNMAP
1088 #   define GC_unmapped_bytes GC_arrays._unmapped_bytes
1089 # endif
1090 # if defined(MSWIN32) || defined(MSWINCE)
1091 #   define GC_heap_bases GC_arrays._heap_bases
1092 # endif
1093 # ifdef MSWINCE
1094 #   define GC_heap_lengths GC_arrays._heap_lengths
1095 # endif
1096 # define GC_static_roots GC_arrays._static_roots
1097 # define GC_root_index GC_arrays._root_index
1098 # define GC_excl_table GC_arrays._excl_table
1099 # define GC_all_nils GC_arrays._all_nils
1100 # define GC_top_index GC_arrays._top_index
1101 # if defined(PROC_VDB) || defined(MPROTECT_VDB)
1102 #   define GC_grungy_pages GC_arrays._grungy_pages
1103 # endif
1104 # ifdef MPROTECT_VDB
1105 #   define GC_dirty_pages GC_arrays._dirty_pages
1106 # endif
1107 # ifdef PROC_VDB
1108 #   define GC_written_pages GC_arrays._written_pages
1109 # endif
1110 # ifdef GATHERSTATS
1111 #   define GC_composite_in_use GC_arrays._composite_in_use
1112 #   define GC_atomic_in_use GC_arrays._atomic_in_use
1113 # endif
1114 # ifdef MERGE_SIZES
1115 #   define GC_size_map GC_arrays._size_map
1116 # endif
1117
1118 # define beginGC_arrays ((ptr_t)(&GC_arrays))
1119 # define endGC_arrays (((ptr_t)(&GC_arrays)) + (sizeof GC_arrays))
1120
1121 #define USED_HEAP_SIZE (GC_heapsize - GC_large_free_bytes)
1122
1123 /* Object kinds: */
1124 # define MAXOBJKINDS 16
1125
1126 extern struct obj_kind {
1127    ptr_t *ok_freelist;  /* Array of free listheaders for this kind of object */
1128                         /* Point either to GC_arrays or to storage allocated */
1129                         /* with GC_scratch_alloc.                            */
1130    struct hblk **ok_reclaim_list;
1131                         /* List headers for lists of blocks waiting to be */
1132                         /* swept.                                         */
1133    word ok_descriptor;  /* Descriptor template for objects in this      */
1134                         /* block.                                       */
1135    GC_bool ok_relocate_descr;
1136                         /* Add object size in bytes to descriptor       */
1137                         /* template to obtain descriptor.  Otherwise    */
1138                         /* template is used as is.                      */
1139    GC_bool ok_init;   /* Clear objects before putting them on the free list. */
1140 } GC_obj_kinds[MAXOBJKINDS];
1141
1142 # define beginGC_obj_kinds ((ptr_t)(&GC_obj_kinds))
1143 # define endGC_obj_kinds (beginGC_obj_kinds + (sizeof GC_obj_kinds))
1144
1145 /* Variables that used to be in GC_arrays, but need to be accessed by   */
1146 /* inline allocation code.  If they were in GC_arrays, the inlined      */
1147 /* allocation code would include GC_arrays offsets (as it did), which   */
1148 /* introduce maintenance problems.                                      */
1149
1150 #ifdef SEPARATE_GLOBALS
1151   word GC_words_allocd;
1152         /* Number of words allocated during this collection cycle */
1153   ptr_t GC_objfreelist[MAXOBJSZ+1];
1154                           /* free list for NORMAL objects */
1155 # define beginGC_objfreelist ((ptr_t)(&GC_objfreelist))
1156 # define endGC_objfreelist (beginGC_objfreelist + sizeof(GC_objfreelist))
1157
1158   ptr_t GC_aobjfreelist[MAXOBJSZ+1];
1159                           /* free list for atomic (PTRFREE) objs        */
1160 # define beginGC_aobjfreelist ((ptr_t)(&GC_aobjfreelist))
1161 # define endGC_aobjfreelist (beginGC_aobjfreelist + sizeof(GC_aobjfreelist))
1162 #endif
1163
1164 /* Predefined kinds: */
1165 # define PTRFREE 0
1166 # define NORMAL  1
1167 # define UNCOLLECTABLE 2
1168 # ifdef ATOMIC_UNCOLLECTABLE
1169 #   define AUNCOLLECTABLE 3
1170 #   define STUBBORN 4
1171 #   define IS_UNCOLLECTABLE(k) (((k) & ~1) == UNCOLLECTABLE)
1172 # else
1173 #   define STUBBORN 3
1174 #   define IS_UNCOLLECTABLE(k) ((k) == UNCOLLECTABLE)
1175 # endif
1176
1177 extern int GC_n_kinds;
1178
1179 GC_API word GC_fo_entries;
1180
1181 extern word GC_n_heap_sects;    /* Number of separately added heap      */
1182                                 /* sections.                            */
1183
1184 extern word GC_page_size;
1185
1186 # if defined(MSWIN32) || defined(MSWINCE)
1187   struct _SYSTEM_INFO;
1188   extern struct _SYSTEM_INFO GC_sysinfo;
1189   extern word GC_n_heap_bases;  /* See GC_heap_bases.   */
1190 # endif
1191
1192 extern word GC_total_stack_black_listed;
1193                         /* Number of bytes on stack blacklist.  */
1194
1195 extern word GC_black_list_spacing;
1196                         /* Average number of bytes between blacklisted  */
1197                         /* blocks. Approximate.                         */
1198                         /* Counts only blocks that are                  */
1199                         /* "stack-blacklisted", i.e. that are           */
1200                         /* problematic in the interior of an object.    */
1201
1202 extern map_entry_type * GC_invalid_map;
1203                         /* Pointer to the nowhere valid hblk map */
1204                         /* Blocks pointing to this map are free. */
1205
1206 extern struct hblk * GC_hblkfreelist[];
1207                                 /* List of completely empty heap blocks */
1208                                 /* Linked through hb_next field of      */
1209                                 /* header structure associated with     */
1210                                 /* block.                               */
1211
1212 extern GC_bool GC_objects_are_marked;   /* There are marked objects in  */
1213                                         /* the heap.                    */
1214
1215 #ifndef SMALL_CONFIG
1216   extern GC_bool GC_incremental;
1217                         /* Using incremental/generational collection. */
1218 # define TRUE_INCREMENTAL \
1219         (GC_incremental && GC_time_limit != GC_TIME_UNLIMITED)
1220         /* True incremental, not just generational, mode */
1221 #else
1222 # define GC_incremental FALSE
1223                         /* Hopefully allow optimizer to remove some code. */
1224 # define TRUE_INCREMENTAL FALSE
1225 #endif
1226
1227 extern GC_bool GC_dirty_maintained;
1228                                 /* Dirty bits are being maintained,     */
1229                                 /* either for incremental collection,   */
1230                                 /* or to limit the root set.            */
1231
1232 extern word GC_root_size;       /* Total size of registered root sections */
1233
1234 extern GC_bool GC_debugging_started;    /* GC_debug_malloc has been called. */ 
1235
1236 extern long GC_large_alloc_warn_interval;
1237         /* Interval between unsuppressed warnings.      */
1238
1239 extern long GC_large_alloc_warn_suppressed;
1240         /* Number of warnings suppressed so far.        */
1241
1242 #ifdef THREADS
1243   extern GC_bool GC_world_stopped;
1244 #endif
1245
1246 /* Operations */
1247 # ifndef abs
1248 #   define abs(x)  ((x) < 0? (-(x)) : (x))
1249 # endif
1250
1251
1252 /*  Marks are in a reserved area in                          */
1253 /*  each heap block.  Each word has one mark bit associated  */
1254 /*  with it. Only those corresponding to the beginning of an */
1255 /*  object are used.                                         */
1256
1257 /* Set mark bit correctly, even if mark bits may be concurrently        */
1258 /* accessed.                                                            */
1259 #ifdef PARALLEL_MARK
1260 # define OR_WORD(addr, bits) \
1261         { word old; \
1262           do { \
1263             old = *((volatile word *)addr); \
1264           } while (!GC_compare_and_exchange((addr), old, old | (bits))); \
1265         }
1266 # define OR_WORD_EXIT_IF_SET(addr, bits, exit_label) \
1267         { word old; \
1268           word my_bits = (bits); \
1269           do { \
1270             old = *((volatile word *)addr); \
1271             if (old & my_bits) goto exit_label; \
1272           } while (!GC_compare_and_exchange((addr), old, old | my_bits)); \
1273         }
1274 #else
1275 # define OR_WORD(addr, bits) *(addr) |= (bits)
1276 # define OR_WORD_EXIT_IF_SET(addr, bits, exit_label) \
1277         { \
1278           word old = *(addr); \
1279           word my_bits = (bits); \
1280           if (old & my_bits) goto exit_label; \
1281           *(addr) = (old | my_bits); \
1282         }
1283 #endif
1284
1285 /* Mark bit operations */
1286
1287 /*
1288  * Retrieve, set, clear the mark bit corresponding
1289  * to the nth word in a given heap block.
1290  *
1291  * (Recall that bit n corresponds to object beginning at word n
1292  * relative to the beginning of the block, including unused words)
1293  */
1294
1295 #ifdef USE_MARK_BYTES
1296 # define mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[(n) >> 1])
1297 # define set_mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[(n)>>1]) = 1
1298 # define clear_mark_bit_from_hdr(hhdr,n) ((hhdr)->hb_marks[(n)>>1]) = 0
1299 #else /* !USE_MARK_BYTES */
1300 # define mark_bit_from_hdr(hhdr,n) (((hhdr)->hb_marks[divWORDSZ(n)] \
1301                             >> (modWORDSZ(n))) & (word)1)
1302 # define set_mark_bit_from_hdr(hhdr,n) \
1303                             OR_WORD((hhdr)->hb_marks+divWORDSZ(n), \
1304                                     (word)1 << modWORDSZ(n))
1305 # define clear_mark_bit_from_hdr(hhdr,n) (hhdr)->hb_marks[divWORDSZ(n)] \
1306                                 &= ~((word)1 << modWORDSZ(n))
1307 #endif /* !USE_MARK_BYTES */
1308
1309 /* Important internal collector routines */
1310
1311 ptr_t GC_approx_sp GC_PROTO((void));
1312   
1313 GC_bool GC_should_collect GC_PROTO((void));
1314   
1315 void GC_apply_to_all_blocks GC_PROTO(( \
1316     void (*fn) GC_PROTO((struct hblk *h, word client_data)), \
1317     word client_data));
1318                         /* Invoke fn(hbp, client_data) for each         */
1319                         /* allocated heap block.                        */
1320 struct hblk * GC_next_used_block GC_PROTO((struct hblk * h));
1321                         /* Return first in-use block >= h       */
1322 struct hblk * GC_prev_block GC_PROTO((struct hblk * h));
1323                         /* Return last block <= h.  Returned block      */
1324                         /* is managed by GC, but may or may not be in   */
1325                         /* use.                                         */
1326 void GC_mark_init GC_PROTO((void));
1327 void GC_clear_marks GC_PROTO((void));   /* Clear mark bits for all heap objects. */
1328 void GC_invalidate_mark_state GC_PROTO((void));
1329                                         /* Tell the marker that marked     */
1330                                         /* objects may point to unmarked   */
1331                                         /* ones, and roots may point to    */
1332                                         /* unmarked objects.               */
1333                                         /* Reset mark stack.               */
1334 GC_bool GC_mark_stack_empty GC_PROTO((void));
1335 GC_bool GC_mark_some GC_PROTO((ptr_t cold_gc_frame));
1336                         /* Perform about one pages worth of marking     */
1337                         /* work of whatever kind is needed.  Returns    */
1338                         /* quickly if no collection is in progress.     */
1339                         /* Return TRUE if mark phase finished.          */
1340 void GC_initiate_gc GC_PROTO((void));
1341                                 /* initiate collection.                 */
1342                                 /* If the mark state is invalid, this   */
1343                                 /* becomes full colleection.  Otherwise */
1344                                 /* it's partial.                        */
1345 void GC_push_all GC_PROTO((ptr_t bottom, ptr_t top));
1346                                 /* Push everything in a range           */
1347                                 /* onto mark stack.                     */
1348 void GC_push_selected GC_PROTO(( \
1349     ptr_t bottom, \
1350     ptr_t top, \
1351     int (*dirty_fn) GC_PROTO((struct hblk *h)), \
1352     void (*push_fn) GC_PROTO((ptr_t bottom, ptr_t top)) ));
1353                                   /* Push all pages h in [b,t) s.t.     */
1354                                   /* select_fn(h) != 0 onto mark stack. */
1355 #ifndef SMALL_CONFIG
1356   void GC_push_conditional GC_PROTO((ptr_t b, ptr_t t, GC_bool all));
1357 #else
1358 # define GC_push_conditional(b, t, all) GC_push_all(b, t)
1359 #endif
1360                                 /* Do either of the above, depending    */
1361                                 /* on the third arg.                    */
1362 void GC_push_all_stack GC_PROTO((ptr_t b, ptr_t t));
1363                                     /* As above, but consider           */
1364                                     /*  interior pointers as valid      */
1365 void GC_push_all_eager GC_PROTO((ptr_t b, ptr_t t));
1366                                     /* Same as GC_push_all_stack, but   */
1367                                     /* ensures that stack is scanned    */
1368                                     /* immediately, not just scheduled  */
1369                                     /* for scanning.                    */
1370 #ifndef THREADS
1371   void GC_push_all_stack_partially_eager GC_PROTO(( \
1372       ptr_t bottom, ptr_t top, ptr_t cold_gc_frame ));
1373                         /* Similar to GC_push_all_eager, but only the   */
1374                         /* part hotter than cold_gc_frame is scanned    */
1375                         /* immediately.  Needed to ensure that callee-  */
1376                         /* save registers are not missed.               */
1377 #else
1378   /* In the threads case, we push part of the current thread stack      */
1379   /* with GC_push_all_eager when we push the registers.  This gets the  */
1380   /* callee-save registers that may disappear.  The remainder of the    */
1381   /* stacks are scheduled for scanning in *GC_push_other_roots, which   */
1382   /* is thread-package-specific.                                        */
1383 #endif
1384 void GC_push_current_stack GC_PROTO((ptr_t cold_gc_frame));
1385                         /* Push enough of the current stack eagerly to  */
1386                         /* ensure that callee-save registers saved in   */
1387                         /* GC frames are scanned.                       */
1388                         /* In the non-threads case, schedule entire     */
1389                         /* stack for scanning.                          */
1390 void GC_push_roots GC_PROTO((GC_bool all, ptr_t cold_gc_frame));
1391                         /* Push all or dirty roots.     */
1392 extern void (*GC_push_other_roots) GC_PROTO((void));
1393                         /* Push system or application specific roots    */
1394                         /* onto the mark stack.  In some environments   */
1395                         /* (e.g. threads environments) this is          */
1396                         /* predfined to be non-zero.  A client supplied */
1397                         /* replacement should also call the original    */
1398                         /* function.                                    */
1399 extern void GC_push_gc_structures GC_PROTO((void));
1400                         /* Push GC internal roots.  These are normally  */
1401                         /* included in the static data segment, and     */
1402                         /* Thus implicitly pushed.  But we must do this */
1403                         /* explicitly if normal root processing is      */
1404                         /* disabled.  Calls the following:              */
1405         extern void GC_push_finalizer_structures GC_PROTO((void));
1406         extern void GC_push_stubborn_structures GC_PROTO((void));
1407 #       ifdef THREADS
1408           extern void GC_push_thread_structures GC_PROTO((void));
1409 #       endif
1410 extern void (*GC_start_call_back) GC_PROTO((void));
1411                         /* Called at start of full collections.         */
1412                         /* Not called if 0.  Called with allocation     */
1413                         /* lock held.                                   */
1414                         /* 0 by default.                                */
1415 # if defined(USE_GENERIC_PUSH_REGS)
1416   void GC_generic_push_regs GC_PROTO((ptr_t cold_gc_frame));
1417 # else
1418   void GC_push_regs GC_PROTO((void));
1419 # endif
1420 # if defined(SPARC) || defined(IA64)
1421   /* Cause all stacked registers to be saved in memory.  Return a       */
1422   /* pointer to the top of the corresponding memory stack.              */
1423   word GC_save_regs_in_stack GC_PROTO((void));
1424 # endif
1425                         /* Push register contents onto mark stack.      */
1426                         /* If NURSERY is defined, the default push      */
1427                         /* action can be overridden with GC_push_proc   */
1428
1429 # ifdef NURSERY
1430     extern void (*GC_push_proc)(ptr_t);
1431 # endif
1432 # if defined(MSWIN32) || defined(MSWINCE)
1433   void __cdecl GC_push_one GC_PROTO((word p));
1434 # else
1435   void GC_push_one GC_PROTO((word p));
1436                               /* If p points to an object, mark it    */
1437                               /* and push contents on the mark stack  */
1438                               /* Pointer recognition test always      */
1439                               /* accepts interior pointers, i.e. this */
1440                               /* is appropriate for pointers found on */
1441                               /* stack.                               */
1442 # endif
1443 # if defined(PRINT_BLACK_LIST) || defined(KEEP_BACK_PTRS)
1444   void GC_mark_and_push_stack GC_PROTO((word p, ptr_t source));
1445                                 /* Ditto, omits plausibility test       */
1446 # else
1447   void GC_mark_and_push_stack GC_PROTO((word p));
1448 # endif
1449 void GC_push_marked GC_PROTO((struct hblk * h, hdr * hhdr));
1450                 /* Push contents of all marked objects in h onto        */
1451                 /* mark stack.                                          */
1452 #ifdef SMALL_CONFIG
1453 # define GC_push_next_marked_dirty(h) GC_push_next_marked(h)
1454 #else
1455   struct hblk * GC_push_next_marked_dirty GC_PROTO((struct hblk * h));
1456                 /* Invoke GC_push_marked on next dirty block above h.   */
1457                 /* Return a pointer just past the end of this block.    */
1458 #endif /* !SMALL_CONFIG */
1459 struct hblk * GC_push_next_marked GC_PROTO((struct hblk * h));
1460                 /* Ditto, but also mark from clean pages.       */
1461 struct hblk * GC_push_next_marked_uncollectable GC_PROTO((struct hblk * h));
1462                 /* Ditto, but mark only from uncollectable pages.       */
1463 GC_bool GC_stopped_mark GC_PROTO((GC_stop_func stop_func));
1464                         /* Stop world and mark from all roots   */
1465                         /* and rescuers.                        */
1466 void GC_clear_hdr_marks GC_PROTO((hdr * hhdr));
1467                                     /* Clear the mark bits in a header */
1468 void GC_set_hdr_marks GC_PROTO((hdr * hhdr));
1469                                     /* Set the mark bits in a header */
1470 void GC_set_fl_marks GC_PROTO((ptr_t p));
1471                                     /* Set all mark bits associated with */
1472                                     /* a free list.                      */
1473 void GC_add_roots_inner GC_PROTO((char * b, char * e, GC_bool tmp));
1474 void GC_remove_roots_inner GC_PROTO((char * b, char * e));
1475 GC_bool GC_is_static_root GC_PROTO((ptr_t p));
1476                 /* Is the address p in one of the registered static     */
1477                 /* root sections?                                       */
1478 # if defined(MSWIN32) || defined(_WIN32_WCE_EMULATION)
1479 GC_bool GC_is_tmp_root GC_PROTO((ptr_t p));
1480                 /* Is the address p in one of the temporary static      */
1481                 /* root sections?                                       */
1482 # endif
1483 void GC_register_dynamic_libraries GC_PROTO((void));
1484                 /* Add dynamic library data sections to the root set. */
1485
1486 GC_bool GC_register_main_static_data GC_PROTO((void));
1487                 /* We need to register the main data segment.  Returns  */
1488                 /* TRUE unless this is done implicitly as part of       */
1489                 /* dynamic library registration.                        */
1490   
1491 /* Machine dependent startup routines */
1492 ptr_t GC_get_stack_base GC_PROTO((void));       /* Cold end of stack */
1493 #ifdef IA64
1494   ptr_t GC_get_register_stack_base GC_PROTO((void));
1495                                         /* Cold end of register stack.  */
1496 #endif
1497 void GC_register_data_segments GC_PROTO((void));
1498   
1499 /* Black listing: */
1500 void GC_bl_init GC_PROTO((void));
1501 # ifdef PRINT_BLACK_LIST
1502       void GC_add_to_black_list_normal GC_PROTO((word p, ptr_t source));
1503                         /* Register bits as a possible future false     */
1504                         /* reference from the heap or static data       */
1505 #     define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1506                 if (GC_all_interior_pointers) { \
1507                   GC_add_to_black_list_stack(bits, (ptr_t)(source)); \
1508                 } else { \
1509                   GC_add_to_black_list_normal(bits, (ptr_t)(source)); \
1510                 }
1511 # else
1512       void GC_add_to_black_list_normal GC_PROTO((word p));
1513 #     define GC_ADD_TO_BLACK_LIST_NORMAL(bits, source) \
1514                 if (GC_all_interior_pointers) { \
1515                   GC_add_to_black_list_stack(bits); \
1516                 } else { \
1517                   GC_add_to_black_list_normal(bits); \
1518                 }
1519 # endif
1520
1521 # ifdef PRINT_BLACK_LIST
1522     void GC_add_to_black_list_stack GC_PROTO((word p, ptr_t source));
1523 # else
1524     void GC_add_to_black_list_stack GC_PROTO((word p));
1525 # endif
1526 struct hblk * GC_is_black_listed GC_PROTO((struct hblk * h, word len));
1527                         /* If there are likely to be false references   */
1528                         /* to a block starting at h of the indicated    */
1529                         /* length, then return the next plausible       */
1530                         /* starting location for h that might avoid     */
1531                         /* these false references.                      */
1532 void GC_promote_black_lists GC_PROTO((void));
1533                         /* Declare an end to a black listing phase.     */
1534 void GC_unpromote_black_lists GC_PROTO((void));
1535                         /* Approximately undo the effect of the above.  */
1536                         /* This actually loses some information, but    */
1537                         /* only in a reasonably safe way.               */
1538 word GC_number_stack_black_listed GC_PROTO(( \
1539         struct hblk *start, struct hblk *endp1));
1540                         /* Return the number of (stack) blacklisted     */
1541                         /* blocks in the range for statistical          */
1542                         /* purposes.                                    */
1543                         
1544 ptr_t GC_scratch_alloc GC_PROTO((word bytes));
1545                                 /* GC internal memory allocation for    */
1546                                 /* small objects.  Deallocation is not  */
1547                                 /* possible.                            */
1548         
1549 /* Heap block layout maps: */                   
1550 void GC_invalidate_map GC_PROTO((hdr * hhdr));
1551                                 /* Remove the object map associated     */
1552                                 /* with the block.  This identifies     */
1553                                 /* the block as invalid to the mark     */
1554                                 /* routines.                            */
1555 GC_bool GC_add_map_entry GC_PROTO((word sz));
1556                                 /* Add a heap block map for objects of  */
1557                                 /* size sz to obj_map.                  */
1558                                 /* Return FALSE on failure.             */
1559 void GC_register_displacement_inner GC_PROTO((word offset));
1560                                 /* Version of GC_register_displacement  */
1561                                 /* that assumes lock is already held    */
1562                                 /* and signals are already disabled.    */
1563   
1564 /*  hblk allocation: */         
1565 void GC_new_hblk GC_PROTO((word size_in_words, int kind));
1566                                 /* Allocate a new heap block, and build */
1567                                 /* a free list in it.                   */                              
1568
1569 ptr_t GC_build_fl GC_PROTO((struct hblk *h, word sz,
1570                            GC_bool clear,  ptr_t list));
1571                                 /* Build a free list for objects of     */
1572                                 /* size sz in block h.  Append list to  */
1573                                 /* end of the free lists.  Possibly     */
1574                                 /* clear objects on the list.  Normally */
1575                                 /* called by GC_new_hblk, but also      */
1576                                 /* called explicitly without GC lock.   */
1577
1578 struct hblk * GC_allochblk GC_PROTO(( \
1579         word size_in_words, int kind, unsigned flags));
1580                                 /* Allocate a heap block, inform        */
1581                                 /* the marker that block is valid       */
1582                                 /* for objects of indicated size.       */
1583
1584 ptr_t GC_alloc_large GC_PROTO((word lw, int k, unsigned flags));
1585                         /* Allocate a large block of size lw words.     */
1586                         /* The block is not cleared.                    */
1587                         /* Flags is 0 or IGNORE_OFF_PAGE.               */
1588                         /* Calls GC_allchblk to do the actual           */
1589                         /* allocation, but also triggers GC and/or      */
1590                         /* heap expansion as appropriate.               */
1591                         /* Does not update GC_words_allocd, but does    */
1592                         /* other accounting.                            */
1593
1594 ptr_t GC_alloc_large_and_clear GC_PROTO((word lw, int k, unsigned flags));
1595                         /* As above, but clear block if appropriate     */
1596                         /* for kind k.                                  */
1597
1598 void GC_freehblk GC_PROTO((struct hblk * p));
1599                                 /* Deallocate a heap block and mark it  */
1600                                 /* as invalid.                          */
1601                                 
1602 /*  Misc GC: */
1603 void GC_init_inner GC_PROTO((void));
1604 GC_bool GC_expand_hp_inner GC_PROTO((word n));
1605 void GC_start_reclaim GC_PROTO((int abort_if_found));
1606                                 /* Restore unmarked objects to free     */
1607                                 /* lists, or (if abort_if_found is      */
1608                                 /* TRUE) report them.                   */
1609                                 /* Sweeping of small object pages is    */
1610                                 /* largely deferred.                    */
1611 void GC_continue_reclaim GC_PROTO((word sz, int kind));
1612                                 /* Sweep pages of the given size and    */
1613                                 /* kind, as long as possible, and       */
1614                                 /* as long as the corr. free list is    */
1615                                 /* empty.                               */
1616 void GC_reclaim_or_delete_all GC_PROTO((void));
1617                                 /* Arrange for all reclaim lists to be  */
1618                                 /* empty.  Judiciously choose between   */
1619                                 /* sweeping and discarding each page.   */
1620 GC_bool GC_reclaim_all GC_PROTO((GC_stop_func stop_func, GC_bool ignore_old));
1621                                 /* Reclaim all blocks.  Abort (in a     */
1622                                 /* consistent state) if f returns TRUE. */
1623 GC_bool GC_block_empty GC_PROTO((hdr * hhdr));
1624                                 /* Block completely unmarked?   */
1625 GC_bool GC_never_stop_func GC_PROTO((void));
1626                                 /* Returns FALSE.               */
1627 GC_bool GC_try_to_collect_inner GC_PROTO((GC_stop_func f));
1628
1629                                 /* Collect; caller must have acquired   */
1630                                 /* lock and disabled signals.           */
1631                                 /* Collection is aborted if f returns   */
1632                                 /* TRUE.  Returns TRUE if it completes  */
1633                                 /* successfully.                        */
1634 # define GC_gcollect_inner() \
1635         (void) GC_try_to_collect_inner(GC_never_stop_func)
1636 void GC_finish_collection GC_PROTO((void));
1637                                 /* Finish collection.  Mark bits are    */
1638                                 /* consistent and lock is still held.   */
1639 GC_bool GC_collect_or_expand GC_PROTO(( \
1640         word needed_blocks, GC_bool ignore_off_page));
1641                                 /* Collect or expand heap in an attempt */
1642                                 /* make the indicated number of free    */
1643                                 /* blocks available.  Should be called  */
1644                                 /* until the blocks are available or    */
1645                                 /* until it fails by returning FALSE.   */
1646
1647 extern GC_bool GC_is_initialized;       /* GC_init() has been run.      */
1648
1649 #if defined(MSWIN32) || defined(MSWINCE)
1650   void GC_deinit GC_PROTO((void));
1651                                 /* Free any resources allocated by      */
1652                                 /* GC_init                              */
1653 #endif
1654
1655 void GC_collect_a_little_inner GC_PROTO((int n));
1656                                 /* Do n units worth of garbage          */
1657                                 /* collection work, if appropriate.     */
1658                                 /* A unit is an amount appropriate for  */
1659                                 /* HBLKSIZE bytes of allocation.        */
1660 /* ptr_t GC_generic_malloc GC_PROTO((word lb, int k)); */
1661                                 /* Allocate an object of the given      */
1662                                 /* kind.  By default, there are only    */
1663                                 /* a few kinds: composite(pointerfree), */
1664                                 /* atomic, uncollectable, etc.          */
1665                                 /* We claim it's possible for clever    */
1666                                 /* client code that understands GC      */
1667                                 /* internals to add more, e.g. to       */
1668                                 /* communicate object layout info       */
1669                                 /* to the collector.                    */
1670                                 /* The actual decl is in gc_mark.h.     */
1671 ptr_t GC_generic_malloc_ignore_off_page GC_PROTO((size_t b, int k));
1672                                 /* As above, but pointers past the      */
1673                                 /* first page of the resulting object   */
1674                                 /* are ignored.                         */
1675 ptr_t GC_generic_malloc_inner GC_PROTO((word lb, int k));
1676                                 /* Ditto, but I already hold lock, etc. */
1677 ptr_t GC_generic_malloc_words_small_inner GC_PROTO((word lw, int k));
1678                                 /* Analogous to the above, but assumes  */
1679                                 /* a small object size, and bypasses    */
1680                                 /* MERGE_SIZES mechanism.               */
1681 ptr_t GC_generic_malloc_words_small GC_PROTO((size_t lw, int k));
1682                                 /* As above, but size in units of words */
1683                                 /* Bypasses MERGE_SIZES.  Assumes       */
1684                                 /* words <= MAXOBJSZ.                   */
1685 ptr_t GC_generic_malloc_inner_ignore_off_page GC_PROTO((size_t lb, int k));
1686                                 /* Allocate an object, where            */
1687                                 /* the client guarantees that there     */
1688                                 /* will always be a pointer to the      */
1689                                 /* beginning of the object while the    */
1690                                 /* object is live.                      */
1691 ptr_t GC_allocobj GC_PROTO((word sz, int kind));
1692                                 /* Make the indicated                   */
1693                                 /* free list nonempty, and return its   */
1694                                 /* head.                                */
1695
1696 void GC_free_inner(GC_PTR p);
1697   
1698 void GC_init_headers GC_PROTO((void));
1699 struct hblkhdr * GC_install_header GC_PROTO((struct hblk *h));
1700                                 /* Install a header for block h.        */
1701                                 /* Return 0 on failure, or the header   */
1702                                 /* otherwise.                           */
1703 GC_bool GC_install_counts GC_PROTO((struct hblk * h, word sz));
1704                                 /* Set up forwarding counts for block   */
1705                                 /* h of size sz.                        */
1706                                 /* Return FALSE on failure.             */
1707 void GC_remove_header GC_PROTO((struct hblk * h));
1708                                 /* Remove the header for block h.       */
1709 void GC_remove_counts GC_PROTO((struct hblk * h, word sz));
1710                                 /* Remove forwarding counts for h.      */
1711 hdr * GC_find_header GC_PROTO((ptr_t h)); /* Debugging only.            */
1712   
1713 void GC_finalize GC_PROTO((void));
1714                         /* Perform all indicated finalization actions   */
1715                         /* on unmarked objects.                         */
1716                         /* Unreachable finalizable objects are enqueued */
1717                         /* for processing by GC_invoke_finalizers.      */
1718                         /* Invoked with lock.                           */
1719
1720 void GC_notify_or_invoke_finalizers GC_PROTO((void));
1721                         /* If GC_finalize_on_demand is not set, invoke  */
1722                         /* eligible finalizers. Otherwise:              */
1723                         /* Call *GC_finalizer_notifier if there are     */
1724                         /* finalizers to be run, and we haven't called  */
1725                         /* this procedure yet this GC cycle.            */
1726
1727 GC_API GC_PTR GC_make_closure GC_PROTO((GC_finalization_proc fn, GC_PTR data));
1728 GC_API void GC_debug_invoke_finalizer GC_PROTO((GC_PTR obj, GC_PTR data));
1729                         /* Auxiliary fns to make finalization work      */
1730                         /* correctly with displaced pointers introduced */
1731                         /* by the debugging allocators.                 */
1732                         
1733 void GC_add_to_heap GC_PROTO((struct hblk *p, word bytes));
1734                         /* Add a HBLKSIZE aligned chunk to the heap.    */
1735   
1736 void GC_print_obj GC_PROTO((ptr_t p));
1737                         /* P points to somewhere inside an object with  */
1738                         /* debugging info.  Print a human readable      */
1739                         /* description of the object to stderr.         */
1740 extern void (*GC_check_heap) GC_PROTO((void));
1741                         /* Check that all objects in the heap with      */
1742                         /* debugging info are intact.                   */
1743                         /* Add any that are not to GC_smashed list.     */
1744 extern void (*GC_print_all_smashed) GC_PROTO((void));
1745                         /* Print GC_smashed if it's not empty.          */
1746                         /* Clear GC_smashed list.                       */
1747 extern void GC_print_all_errors GC_PROTO((void));
1748                         /* Print smashed and leaked objects, if any.    */
1749                         /* Clear the lists of such objects.             */
1750 extern void (*GC_print_heap_obj) GC_PROTO((ptr_t p));
1751                         /* If possible print s followed by a more       */
1752                         /* detailed description of the object           */
1753                         /* referred to by p.                            */
1754 #if defined(LINUX) && defined(__ELF__) && !defined(SMALL_CONFIG)
1755   void GC_print_address_map GC_PROTO((void));
1756                         /* Print an address map of the process.         */
1757 #endif
1758
1759 extern GC_bool GC_have_errors;  /* We saw a smashed or leaked object.   */
1760                                 /* Call error printing routine          */
1761                                 /* occasionally.                        */
1762 extern GC_bool GC_print_stats;  /* Produce at least some logging output */
1763                                 /* Set from environment variable.       */
1764
1765 #ifndef NO_DEBUGGING
1766   extern GC_bool GC_dump_regularly;  /* Generate regular debugging dumps. */
1767 # define COND_DUMP if (GC_dump_regularly) GC_dump();
1768 #else
1769 # define COND_DUMP
1770 #endif
1771
1772 #ifdef KEEP_BACK_PTRS
1773   extern long GC_backtraces;
1774   void GC_generate_random_backtrace_no_gc(void);
1775 #endif
1776
1777 extern GC_bool GC_print_back_height;
1778
1779 #ifdef MAKE_BACK_GRAPH
1780   void GC_print_back_graph_stats(void);
1781 #endif
1782
1783 /* Macros used for collector internal allocation.       */
1784 /* These assume the collector lock is held.             */
1785 #ifdef DBG_HDRS_ALL
1786     extern GC_PTR GC_debug_generic_malloc_inner(size_t lb, int k);
1787     extern GC_PTR GC_debug_generic_malloc_inner_ignore_off_page(size_t lb,
1788                                                                 int k);
1789 #   define GC_INTERNAL_MALLOC GC_debug_generic_malloc_inner
1790 #   define GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE \
1791                  GC_debug_generic_malloc_inner_ignore_off_page
1792 #   ifdef THREADS
1793 #       define GC_INTERNAL_FREE GC_debug_free_inner
1794 #   else
1795 #       define GC_INTERNAL_FREE GC_debug_free
1796 #   endif
1797 #else
1798 #   define GC_INTERNAL_MALLOC GC_generic_malloc_inner
1799 #   define GC_INTERNAL_MALLOC_IGNORE_OFF_PAGE \
1800                  GC_generic_malloc_inner_ignore_off_page
1801 #   ifdef THREADS
1802 #       define GC_INTERNAL_FREE GC_free_inner
1803 #   else
1804 #       define GC_INTERNAL_FREE GC_free
1805 #   endif
1806 #endif
1807
1808 /* Memory unmapping: */
1809 #ifdef USE_MUNMAP
1810   void GC_unmap_old(void);
1811   void GC_merge_unmapped(void);
1812   void GC_unmap(ptr_t start, word bytes);
1813   void GC_remap(ptr_t start, word bytes);
1814   void GC_unmap_gap(ptr_t start1, word bytes1, ptr_t start2, word bytes2);
1815 #endif
1816
1817 /* Virtual dirty bit implementation:            */
1818 /* Each implementation exports the following:   */
1819 void GC_read_dirty GC_PROTO((void));
1820                         /* Retrieve dirty bits. */
1821 GC_bool GC_page_was_dirty GC_PROTO((struct hblk *h));
1822                         /* Read retrieved dirty bits.   */
1823 GC_bool GC_page_was_ever_dirty GC_PROTO((struct hblk *h));
1824                         /* Could the page contain valid heap pointers?  */
1825 void GC_is_fresh GC_PROTO((struct hblk *h, word n));
1826                         /* Assert the region currently contains no      */
1827                         /* valid pointers.                              */
1828 void GC_remove_protection GC_PROTO((struct hblk *h, word nblocks,
1829                                     GC_bool pointerfree));
1830                         /* h is about to be writteni or allocated.  Ensure  */
1831                         /* that it's not write protected by the virtual     */
1832                         /* dirty bit implementation.                        */
1833                         
1834 void GC_dirty_init GC_PROTO((void));
1835   
1836 /* Slow/general mark bit manipulation: */
1837 GC_API GC_bool GC_is_marked GC_PROTO((ptr_t p));
1838 void GC_clear_mark_bit GC_PROTO((ptr_t p));
1839 void GC_set_mark_bit GC_PROTO((ptr_t p));
1840   
1841 /* Stubborn objects: */
1842 void GC_read_changed GC_PROTO((void));  /* Analogous to GC_read_dirty */
1843 GC_bool GC_page_was_changed GC_PROTO((struct hblk * h));
1844                                 /* Analogous to GC_page_was_dirty */
1845 void GC_clean_changing_list GC_PROTO((void));
1846                                 /* Collect obsolete changing list entries */
1847 void GC_stubborn_init GC_PROTO((void));
1848   
1849 /* Debugging print routines: */
1850 void GC_print_block_list GC_PROTO((void));
1851 void GC_print_hblkfreelist GC_PROTO((void));
1852 void GC_print_heap_sects GC_PROTO((void));
1853 void GC_print_static_roots GC_PROTO((void));
1854 void GC_print_finalization_stats GC_PROTO((void));
1855 void GC_dump GC_PROTO((void));
1856
1857 #ifdef KEEP_BACK_PTRS
1858    void GC_store_back_pointer(ptr_t source, ptr_t dest);
1859    void GC_marked_for_finalization(ptr_t dest);
1860 #  define GC_STORE_BACK_PTR(source, dest) GC_store_back_pointer(source, dest)
1861 #  define GC_MARKED_FOR_FINALIZATION(dest) GC_marked_for_finalization(dest)
1862 #else
1863 #  define GC_STORE_BACK_PTR(source, dest) 
1864 #  define GC_MARKED_FOR_FINALIZATION(dest)
1865 #endif
1866
1867 /* Make arguments appear live to compiler */
1868 # ifdef __WATCOMC__
1869     void GC_noop(void*, ...);
1870 # else
1871 #   ifdef __DMC__
1872       GC_API void GC_noop(...);
1873 #   else
1874       GC_API void GC_noop();
1875 #   endif
1876 # endif
1877
1878 void GC_noop1 GC_PROTO((word));
1879
1880 /* Logging and diagnostic output:       */
1881 GC_API void GC_printf GC_PROTO((GC_CONST char * format, long, long, long, long, long, long));
1882                         /* A version of printf that doesn't allocate,   */
1883                         /* is restricted to long arguments, and         */
1884                         /* (unfortunately) doesn't use varargs for      */
1885                         /* portability.  Restricted to 6 args and       */
1886                         /* 1K total output length.                      */
1887                         /* (We use sprintf.  Hopefully that doesn't     */
1888                         /* allocate for long arguments.)                */
1889 # define GC_printf0(f) GC_printf(f, 0l, 0l, 0l, 0l, 0l, 0l)
1890 # define GC_printf1(f,a) GC_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1891 # define GC_printf2(f,a,b) GC_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1892 # define GC_printf3(f,a,b,c) GC_printf(f, (long)a, (long)b, (long)c, 0l, 0l, 0l)
1893 # define GC_printf4(f,a,b,c,d) GC_printf(f, (long)a, (long)b, (long)c, \
1894                                             (long)d, 0l, 0l)
1895 # define GC_printf5(f,a,b,c,d,e) GC_printf(f, (long)a, (long)b, (long)c, \
1896                                               (long)d, (long)e, 0l)
1897 # define GC_printf6(f,a,b,c,d,e,g) GC_printf(f, (long)a, (long)b, (long)c, \
1898                                                 (long)d, (long)e, (long)g)
1899
1900 GC_API void GC_err_printf GC_PROTO((GC_CONST char * format, long, long, long, long, long, long));
1901 # define GC_err_printf0(f) GC_err_puts(f)
1902 # define GC_err_printf1(f,a) GC_err_printf(f, (long)a, 0l, 0l, 0l, 0l, 0l)
1903 # define GC_err_printf2(f,a,b) GC_err_printf(f, (long)a, (long)b, 0l, 0l, 0l, 0l)
1904 # define GC_err_printf3(f,a,b,c) GC_err_printf(f, (long)a, (long)b, (long)c, \
1905                                                   0l, 0l, 0l)
1906 # define GC_err_printf4(f,a,b,c,d) GC_err_printf(f, (long)a, (long)b, \
1907                                                     (long)c, (long)d, 0l, 0l)
1908 # define GC_err_printf5(f,a,b,c,d,e) GC_err_printf(f, (long)a, (long)b, \
1909                                                       (long)c, (long)d, \
1910                                                       (long)e, 0l)
1911 # define GC_err_printf6(f,a,b,c,d,e,g) GC_err_printf(f, (long)a, (long)b, \
1912                                                         (long)c, (long)d, \
1913                                                         (long)e, (long)g)
1914                         /* Ditto, writes to stderr.                     */
1915                         
1916 void GC_err_puts GC_PROTO((GC_CONST char *s));
1917                         /* Write s to stderr, don't buffer, don't add   */
1918                         /* newlines, don't ...                          */
1919
1920 #if defined(LINUX) && !defined(SMALL_CONFIG)
1921   void GC_err_write GC_PROTO((GC_CONST char *buf, size_t len));
1922                         /* Write buf to stderr, don't buffer, don't add */
1923                         /* newlines, don't ...                          */
1924 #endif
1925
1926
1927 # ifdef GC_ASSERTIONS
1928 #       define GC_ASSERT(expr) if(!(expr)) {\
1929                 GC_err_printf2("Assertion failure: %s:%ld\n", \
1930                                 __FILE__, (unsigned long)__LINE__); \
1931                 ABORT("assertion failure"); }
1932 # else 
1933 #       define GC_ASSERT(expr)
1934 # endif
1935
1936 /* Check a compile time assertion at compile time.  The error   */
1937 /* message for failure is a bit baroque, but ...                */
1938 #if defined(mips) && !defined(__GNUC__)
1939 /* DOB: MIPSPro C gets an internal error taking the sizeof an array type. 
1940    This code works correctly (ugliness is to avoid "unused var" warnings) */
1941 # define GC_STATIC_ASSERT(expr) do { if (0) { char j[(expr)? 1 : -1]; j[0]='\0'; j[0]=j[0]; } } while(0)
1942 #else
1943 # define GC_STATIC_ASSERT(expr) sizeof(char[(expr)? 1 : -1])
1944 #endif
1945
1946 # if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
1947     /* We need additional synchronization facilities from the thread    */
1948     /* support.  We believe these are less performance critical         */
1949     /* than the main garbage collector lock; standard pthreads-based    */
1950     /* implementations should be sufficient.                            */
1951
1952     /* The mark lock and condition variable.  If the GC lock is also    */
1953     /* acquired, the GC lock must be acquired first.  The mark lock is  */
1954     /* used to both protect some variables used by the parallel         */
1955     /* marker, and to protect GC_fl_builder_count, below.               */
1956     /* GC_notify_all_marker() is called when                            */ 
1957     /* the state of the parallel marker changes                         */
1958     /* in some significant way (see gc_mark.h for details).  The        */
1959     /* latter set of events includes incrementing GC_mark_no.           */
1960     /* GC_notify_all_builder() is called when GC_fl_builder_count       */
1961     /* reaches 0.                                                       */
1962
1963      extern void GC_acquire_mark_lock();
1964      extern void GC_release_mark_lock();
1965      extern void GC_notify_all_builder();
1966      /* extern void GC_wait_builder(); */
1967      extern void GC_wait_for_reclaim();
1968
1969      extern word GC_fl_builder_count;   /* Protected by mark lock.      */
1970 # endif /* PARALLEL_MARK || THREAD_LOCAL_ALLOC */
1971 # ifdef PARALLEL_MARK
1972      extern void GC_notify_all_marker();
1973      extern void GC_wait_marker();
1974      extern word GC_mark_no;            /* Protected by mark lock.      */
1975
1976      extern void GC_help_marker(word my_mark_no);
1977                 /* Try to help out parallel marker for mark cycle       */
1978                 /* my_mark_no.  Returns if the mark cycle finishes or   */
1979                 /* was already done, or there was nothing to do for     */
1980                 /* some other reason.                                   */
1981 # endif /* PARALLEL_MARK */
1982
1983 # if defined(GC_PTHREADS) && !defined(GC_SOLARIS_THREADS)
1984   /* We define the thread suspension signal here, so that we can refer  */
1985   /* to it in the dirty bit implementation, if necessary.  Ideally we   */
1986   /* would allocate a (real-time ?) signal using the standard mechanism.*/
1987   /* unfortunately, there is no standard mechanism.  (There is one      */
1988   /* in Linux glibc, but it's not exported.)  Thus we continue to use   */
1989   /* the same hard-coded signals we've always used.                     */
1990 #  if !defined(SIG_SUSPEND)
1991 #   if defined(GC_LINUX_THREADS) || defined(GC_DGUX386_THREADS)
1992 #    if defined(SPARC) && !defined(SIGPWR)
1993        /* SPARC/Linux doesn't properly define SIGPWR in <signal.h>.
1994         * It is aliased to SIGLOST in asm/signal.h, though.             */
1995 #      define SIG_SUSPEND SIGLOST
1996 #    else
1997        /* Linuxthreads itself uses SIGUSR1 and SIGUSR2.                 */
1998 #      define SIG_SUSPEND SIGPWR
1999 #    endif
2000 #   else  /* !GC_LINUX_THREADS */
2001 #     if defined(_SIGRTMIN)
2002 #       define SIG_SUSPEND _SIGRTMIN + 6
2003 #     else
2004 #       define SIG_SUSPEND SIGRTMIN + 6
2005 #     endif       
2006 #   endif
2007 #  endif /* !SIG_SUSPEND */
2008   
2009 # endif
2010
2011 # endif /* GC_PRIVATE_H */