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