root/gc/include/gc.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. GC_PROTO

   1 /* 
   2  * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
   3  * Copyright (c) 1991-1995 by Xerox Corporation.  All rights reserved.
   4  * Copyright 1996-1999 by Silicon Graphics.  All rights reserved.
   5  * Copyright 1999 by Hewlett-Packard Company.  All rights reserved.
   6  *
   7  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   8  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   9  *
  10  * Permission is hereby granted to use or copy this program
  11  * for any purpose,  provided the above notices are retained on all copies.
  12  * Permission to modify the code and to distribute modified code is granted,
  13  * provided the above notices are retained, and a notice that the code was
  14  * modified is included with the above copyright notice.
  15  */
  16 
  17 /*
  18  * Note that this defines a large number of tuning hooks, which can
  19  * safely be ignored in nearly all cases.  For normal use it suffices
  20  * to call only GC_MALLOC and perhaps GC_REALLOC.
  21  * For better performance, also look at GC_MALLOC_ATOMIC, and
  22  * GC_enable_incremental.  If you need an action to be performed
  23  * immediately before an object is collected, look at GC_register_finalizer.
  24  * If you are using Solaris threads, look at the end of this file.
  25  * Everything else is best ignored unless you encounter performance
  26  * problems.
  27  */
  28  
  29 #ifndef _GC_H
  30 
  31 # define _GC_H
  32 
  33 # include "gc_config_macros.h"
  34 
  35 # if defined(__STDC__) || defined(__cplusplus) || defined(_AIX)
  36 #   define GC_PROTO(args) args
  37     typedef void * GC_PTR;
  38 #   define GC_CONST const
  39 # else
  40 #   define GC_PROTO(args) ()
  41     typedef char * GC_PTR;
  42 #   define GC_CONST
  43 #  endif
  44 
  45 # ifdef __cplusplus
  46     extern "C" {
  47 # endif
  48 
  49 
  50 /* Define word and signed_word to be unsigned and signed types of the   */
  51 /* size as char * or void *.  There seems to be no way to do this       */
  52 /* even semi-portably.  The following is probably no better/worse       */
  53 /* than almost anything else.                                           */
  54 /* The ANSI standard suggests that size_t and ptr_diff_t might be       */
  55 /* better choices.  But those had incorrect definitions on some older   */
  56 /* systems.  Notably "typedef int size_t" is WRONG.                     */
  57 #ifndef _WIN64
  58   typedef unsigned long GC_word;
  59   typedef long GC_signed_word;
  60 #else
  61   /* Win64 isn't really supported yet, but this is the first step. And  */
  62   /* it might cause error messages to show up in more plausible places. */
  63   /* This needs basetsd.h, which is included by windows.h.              */
  64   typedef ULONG_PTR GC_word;
  65   typedef LONG_PTR GC_word;
  66 #endif
  67 
  68 /* Public read-only variables */
  69 
  70 GC_API GC_word GC_gc_no;/* Counter incremented per collection.          */
  71                         /* Includes empty GCs at startup.               */
  72 
  73 GC_API int GC_parallel; /* GC is parallelized for performance on        */
  74                         /* multiprocessors.  Currently set only         */
  75                         /* implicitly if collector is built with        */
  76                         /* -DPARALLEL_MARK and if either:               */
  77                         /*  Env variable GC_NPROC is set to > 1, or     */
  78                         /*  GC_NPROC is not set and this is an MP.      */
  79                         /* If GC_parallel is set, incremental           */
  80                         /* collection is only partially functional,     */
  81                         /* and may not be desirable.                    */
  82                         
  83 
  84 /* Public R/W variables */
  85 
  86 GC_API GC_PTR (*GC_oom_fn) GC_PROTO((size_t bytes_requested));
  87                         /* When there is insufficient memory to satisfy */
  88                         /* an allocation request, we return             */
  89                         /* (*GC_oom_fn)().  By default this just        */
  90                         /* returns 0.                                   */
  91                         /* If it returns, it must return 0 or a valid   */
  92                         /* pointer to a previously allocated heap       */
  93                         /* object.                                      */
  94 
  95 GC_API int GC_find_leak;
  96                         /* Do not actually garbage collect, but simply  */
  97                         /* report inaccessible memory that was not      */
  98                         /* deallocated with GC_free.  Initial value     */
  99                         /* is determined by FIND_LEAK macro.            */
 100 
 101 GC_API int GC_all_interior_pointers;
 102                         /* Arrange for pointers to object interiors to  */
 103                         /* be recognized as valid.  May not be changed  */
 104                         /* after GC initialization.                     */
 105                         /* Initial value is determined by               */
 106                         /* -DALL_INTERIOR_POINTERS.                     */
 107                         /* Unless DONT_ADD_BYTE_AT_END is defined, this */
 108                         /* also affects whether sizes are increased by  */
 109                         /* at least a byte to allow "off the end"       */
 110                         /* pointer recognition.                         */
 111                         /* MUST BE 0 or 1.                              */
 112 
 113 GC_API int GC_quiet;    /* Disable statistics output.  Only matters if  */
 114                         /* collector has been compiled with statistics  */
 115                         /* enabled.  This involves a performance cost,  */
 116                         /* and is thus not the default.                 */
 117 
 118 GC_API int GC_finalize_on_demand;
 119                         /* If nonzero, finalizers will only be run in   */
 120                         /* response to an explicit GC_invoke_finalizers */
 121                         /* call.  The default is determined by whether  */
 122                         /* the FINALIZE_ON_DEMAND macro is defined      */
 123                         /* when the collector is built.                 */
 124 
 125 GC_API int GC_java_finalization;
 126                         /* Mark objects reachable from finalizable      */
 127                         /* objects in a separate postpass.  This makes  */
 128                         /* it a bit safer to use non-topologically-     */
 129                         /* ordered finalization.  Default value is      */
 130                         /* determined by JAVA_FINALIZATION macro.       */
 131 
 132 GC_API void (* GC_finalizer_notifier)();
 133                         /* Invoked by the collector when there are      */
 134                         /* objects to be finalized.  Invoked at most    */
 135                         /* once per GC cycle.  Never invoked unless     */
 136                         /* GC_finalize_on_demand is set.                */
 137                         /* Typically this will notify a finalization    */
 138                         /* thread, which will call GC_invoke_finalizers */
 139                         /* in response.                                 */
 140 
 141 GC_API int GC_dont_gc;  /* != 0 ==> Dont collect.  In versions 6.2a1+,  */
 142                         /* this overrides explicit GC_gcollect() calls. */
 143                         /* Used as a counter, so that nested enabling   */
 144                         /* and disabling work correctly.  Should        */
 145                         /* normally be updated with GC_enable() and     */
 146                         /* GC_disable() calls.                          */
 147                         /* Direct assignment to GC_dont_gc is           */
 148                         /* deprecated.                                  */
 149 
 150 GC_API int GC_dont_expand;
 151                         /* Dont expand heap unless explicitly requested */
 152                         /* or forced to.                                */
 153 
 154 GC_API int GC_use_entire_heap;
 155                 /* Causes the nonincremental collector to use the       */
 156                 /* entire heap before collecting.  This was the only    */
 157                 /* option for GC versions < 5.0.  This sometimes        */
 158                 /* results in more large block fragmentation, since     */
 159                 /* very larg blocks will tend to get broken up          */
 160                 /* during each GC cycle.  It is likely to result in a   */
 161                 /* larger working set, but lower collection             */
 162                 /* frequencies, and hence fewer instructions executed   */
 163                 /* in the collector.                                    */
 164 
 165 GC_API int GC_full_freq;    /* Number of partial collections between    */
 166                             /* full collections.  Matters only if       */
 167                             /* GC_incremental is set.                   */
 168                             /* Full collections are also triggered if   */
 169                             /* the collector detects a substantial      */
 170                             /* increase in the number of in-use heap    */
 171                             /* blocks.  Values in the tens are now      */
 172                             /* perfectly reasonable, unlike for         */
 173                             /* earlier GC versions.                     */
 174                         
 175 GC_API GC_word GC_non_gc_bytes;
 176                         /* Bytes not considered candidates for collection. */
 177                         /* Used only to control scheduling of collections. */
 178                         /* Updated by GC_malloc_uncollectable and GC_free. */
 179                         /* Wizards only.                                   */
 180 
 181 GC_API int GC_no_dls;
 182                         /* Don't register dynamic library data segments. */
 183                         /* Wizards only.  Should be used only if the     */
 184                         /* application explicitly registers all roots.   */
 185                         /* In Microsoft Windows environments, this will  */
 186                         /* usually also prevent registration of the      */
 187                         /* main data segment as part of the root set.    */
 188 
 189 GC_API GC_word GC_free_space_divisor;
 190                         /* We try to make sure that we allocate at      */
 191                         /* least N/GC_free_space_divisor bytes between  */
 192                         /* collections, where N is the heap size plus   */
 193                         /* a rough estimate of the root set size.       */
 194                         /* Initially, GC_free_space_divisor = 3.        */
 195                         /* Increasing its value will use less space     */
 196                         /* but more collection time.  Decreasing it     */
 197                         /* will appreciably decrease collection time    */
 198                         /* at the expense of space.                     */
 199                         /* GC_free_space_divisor = 1 will effectively   */
 200                         /* disable collections.                         */
 201 
 202 GC_API GC_word GC_max_retries;
 203                         /* The maximum number of GCs attempted before   */
 204                         /* reporting out of memory after heap           */
 205                         /* expansion fails.  Initially 0.               */
 206                         
 207 
 208 GC_API char *GC_stackbottom;    /* Cool end of user stack.              */
 209                                 /* May be set in the client prior to    */
 210                                 /* calling any GC_ routines.  This      */
 211                                 /* avoids some overhead, and            */
 212                                 /* potentially some signals that can    */
 213                                 /* confuse debuggers.  Otherwise the    */
 214                                 /* collector attempts to set it         */
 215                                 /* automatically.                       */
 216                                 /* For multithreaded code, this is the  */
 217                                 /* cold end of the stack for the        */
 218                                 /* primordial thread.                   */      
 219                                 
 220 GC_API int GC_dont_precollect;  /* Don't collect as part of             */
 221                                 /* initialization.  Should be set only  */
 222                                 /* if the client wants a chance to      */
 223                                 /* manually initialize the root set     */
 224                                 /* before the first collection.         */
 225                                 /* Interferes with blacklisting.        */
 226                                 /* Wizards only.                        */
 227 
 228 GC_API unsigned long GC_time_limit;
 229                                 /* If incremental collection is enabled, */
 230                                 /* We try to terminate collections       */
 231                                 /* after this many milliseconds.  Not a  */
 232                                 /* hard time bound.  Setting this to     */
 233                                 /* GC_TIME_UNLIMITED will essentially    */
 234                                 /* disable incremental collection while  */
 235                                 /* leaving generational collection       */
 236                                 /* enabled.                              */
 237 #       define GC_TIME_UNLIMITED 999999
 238                                 /* Setting GC_time_limit to this value   */
 239                                 /* will disable the "pause time exceeded"*/
 240                                 /* tests.                                */
 241 
 242 /* Public procedures */
 243 
 244 /* Initialize the collector.  This is only required when using thread-local
 245  * allocation, since unlike the regular allocation routines, GC_local_malloc
 246  * is not self-initializing.  If you use GC_local_malloc you should arrange
 247  * to call this somehow (e.g. from a constructor) before doing any allocation.
 248  * For win32 threads, it needs to be called explicitly.
 249  */
 250 GC_API void GC_init GC_PROTO((void));
 251 
 252 /*
 253  * general purpose allocation routines, with roughly malloc calling conv.
 254  * The atomic versions promise that no relevant pointers are contained
 255  * in the object.  The nonatomic versions guarantee that the new object
 256  * is cleared.  GC_malloc_stubborn promises that no changes to the object
 257  * will occur after GC_end_stubborn_change has been called on the
 258  * result of GC_malloc_stubborn. GC_malloc_uncollectable allocates an object
 259  * that is scanned for pointers to collectable objects, but is not itself
 260  * collectable.  The object is scanned even if it does not appear to
 261  * be reachable.  GC_malloc_uncollectable and GC_free called on the resulting
 262  * object implicitly update GC_non_gc_bytes appropriately.
 263  *
 264  * Note that the GC_malloc_stubborn support is stubbed out by default
 265  * starting in 6.0.  GC_malloc_stubborn is an alias for GC_malloc unless
 266  * the collector is built with STUBBORN_ALLOC defined.
 267  */
 268 GC_API GC_PTR GC_malloc GC_PROTO((size_t size_in_bytes));
 269 GC_API GC_PTR GC_malloc_atomic GC_PROTO((size_t size_in_bytes));
 270 GC_API GC_PTR GC_malloc_uncollectable GC_PROTO((size_t size_in_bytes));
 271 GC_API GC_PTR GC_malloc_stubborn GC_PROTO((size_t size_in_bytes));
 272 
 273 /* The following is only defined if the library has been suitably       */
 274 /* compiled:                                                            */
 275 GC_API GC_PTR GC_malloc_atomic_uncollectable GC_PROTO((size_t size_in_bytes));
 276 
 277 /* Explicitly deallocate an object.  Dangerous if used incorrectly.     */
 278 /* Requires a pointer to the base of an object.                         */
 279 /* If the argument is stubborn, it should not be changeable when freed. */
 280 /* An object should not be enable for finalization when it is           */
 281 /* explicitly deallocated.                                              */
 282 /* GC_free(0) is a no-op, as required by ANSI C for free.               */
 283 GC_API void GC_free GC_PROTO((GC_PTR object_addr));
 284 
 285 /*
 286  * Stubborn objects may be changed only if the collector is explicitly informed.
 287  * The collector is implicitly informed of coming change when such
 288  * an object is first allocated.  The following routines inform the
 289  * collector that an object will no longer be changed, or that it will
 290  * once again be changed.  Only nonNIL pointer stores into the object
 291  * are considered to be changes.  The argument to GC_end_stubborn_change
 292  * must be exacly the value returned by GC_malloc_stubborn or passed to
 293  * GC_change_stubborn.  (In the second case it may be an interior pointer
 294  * within 512 bytes of the beginning of the objects.)
 295  * There is a performance penalty for allowing more than
 296  * one stubborn object to be changed at once, but it is acceptable to
 297  * do so.  The same applies to dropping stubborn objects that are still
 298  * changeable.
 299  */
 300 GC_API void GC_change_stubborn GC_PROTO((GC_PTR));
 301 GC_API void GC_end_stubborn_change GC_PROTO((GC_PTR));
 302 
 303 /* Return a pointer to the base (lowest address) of an object given     */
 304 /* a pointer to a location within the object.                           */
 305 /* I.e. map an interior pointer to the corresponding bas pointer.       */
 306 /* Note that with debugging allocation, this returns a pointer to the   */
 307 /* actual base of the object, i.e. the debug information, not to        */
 308 /* the base of the user object.                                         */
 309 /* Return 0 if displaced_pointer doesn't point to within a valid        */
 310 /* object.                                                              */
 311 /* Note that a deallocated object in the garbage collected heap         */
 312 /* may be considered valid, even if it has been deallocated with        */
 313 /* GC_free.                                                             */
 314 GC_API GC_PTR GC_base GC_PROTO((GC_PTR displaced_pointer));
 315 
 316 /* Given a pointer to the base of an object, return its size in bytes.  */
 317 /* The returned size may be slightly larger than what was originally    */
 318 /* requested.                                                           */
 319 GC_API size_t GC_size GC_PROTO((GC_PTR object_addr));
 320 
 321 /* For compatibility with C library.  This is occasionally faster than  */
 322 /* a malloc followed by a bcopy.  But if you rely on that, either here  */
 323 /* or with the standard C library, your code is broken.  In my          */
 324 /* opinion, it shouldn't have been invented, but now we're stuck. -HB   */
 325 /* The resulting object has the same kind as the original.              */
 326 /* If the argument is stubborn, the result will have changes enabled.   */
 327 /* It is an error to have changes enabled for the original object.      */
 328 /* Follows ANSI comventions for NULL old_object.                        */
 329 GC_API GC_PTR GC_realloc
 330         GC_PROTO((GC_PTR old_object, size_t new_size_in_bytes));
 331                                    
 332 /* Explicitly increase the heap size.   */
 333 /* Returns 0 on failure, 1 on success.  */
 334 GC_API int GC_expand_hp GC_PROTO((size_t number_of_bytes));
 335 
 336 /* Limit the heap size to n bytes.  Useful when you're debugging,       */
 337 /* especially on systems that don't handle running out of memory well.  */
 338 /* n == 0 ==> unbounded.  This is the default.                          */
 339 GC_API void GC_set_max_heap_size GC_PROTO((GC_word n));
 340 
 341 /* Inform the collector that a certain section of statically allocated  */
 342 /* memory contains no pointers to garbage collected memory.  Thus it    */
 343 /* need not be scanned.  This is sometimes important if the application */
 344 /* maps large read/write files into the address space, which could be   */
 345 /* mistaken for dynamic library data segments on some systems.          */
 346 GC_API void GC_exclude_static_roots GC_PROTO((GC_PTR start, GC_PTR finish));
 347 
 348 /* Clear the set of root segments.  Wizards only. */
 349 GC_API void GC_clear_roots GC_PROTO((void));
 350 
 351 /* Add a root segment.  Wizards only. */
 352 GC_API void GC_add_roots GC_PROTO((char * low_address,
 353                                    char * high_address_plus_1));
 354 
 355 /* Remove a root segment.  Wizards only. */
 356 GC_API void GC_remove_roots GC_PROTO((char * low_address, 
 357     char * high_address_plus_1));
 358 
 359 /* Add a displacement to the set of those considered valid by the       */
 360 /* collector.  GC_register_displacement(n) means that if p was returned */
 361 /* by GC_malloc, then (char *)p + n will be considered to be a valid    */
 362 /* pointer to p.  N must be small and less than the size of p.          */
 363 /* (All pointers to the interior of objects from the stack are          */
 364 /* considered valid in any case.  This applies to heap objects and      */
 365 /* static data.)                                                        */
 366 /* Preferably, this should be called before any other GC procedures.    */
 367 /* Calling it later adds to the probability of excess memory            */
 368 /* retention.                                                           */
 369 /* This is a no-op if the collector has recognition of                  */
 370 /* arbitrary interior pointers enabled, which is now the default.       */
 371 GC_API void GC_register_displacement GC_PROTO((GC_word n));
 372 
 373 /* The following version should be used if any debugging allocation is  */
 374 /* being done.                                                          */
 375 GC_API void GC_debug_register_displacement GC_PROTO((GC_word n));
 376 
 377 /* Explicitly trigger a full, world-stop collection.    */
 378 GC_API void GC_gcollect GC_PROTO((void));
 379 
 380 /* Trigger a full world-stopped collection.  Abort the collection if    */
 381 /* and when stop_func returns a nonzero value.  Stop_func will be       */
 382 /* called frequently, and should be reasonably fast.  This works even   */
 383 /* if virtual dirty bits, and hence incremental collection is not       */
 384 /* available for this architecture.  Collections can be aborted faster  */
 385 /* than normal pause times for incremental collection.  However,        */
 386 /* aborted collections do no useful work; the next collection needs     */
 387 /* to start from the beginning.                                         */
 388 /* Return 0 if the collection was aborted, 1 if it succeeded.           */
 389 typedef int (* GC_stop_func) GC_PROTO((void));
 390 GC_API int GC_try_to_collect GC_PROTO((GC_stop_func stop_func));
 391 
 392 /* Return the number of bytes in the heap.  Excludes collector private  */
 393 /* data structures.  Includes empty blocks and fragmentation loss.      */
 394 /* Includes some pages that were allocated but never written.           */
 395 GC_API size_t GC_get_heap_size GC_PROTO((void));
 396 
 397 /* Return a lower bound on the number of free bytes in the heap.        */
 398 GC_API size_t GC_get_free_bytes GC_PROTO((void));
 399 
 400 /* Return the number of bytes allocated since the last collection.      */
 401 GC_API size_t GC_get_bytes_since_gc GC_PROTO((void));
 402 
 403 /* Return the total number of bytes allocated in this process.          */
 404 /* Never decreases, except due to wrapping.                             */
 405 GC_API size_t GC_get_total_bytes GC_PROTO((void));
 406 
 407 /* Disable garbage collection.  Even GC_gcollect calls will be          */
 408 /* ineffective.                                                         */
 409 GC_API void GC_disable GC_PROTO((void));
 410 
 411 /* Reenable garbage collection.  GC_disable() and GC_enable() calls     */
 412 /* nest.  Garbage collection is enabled if the number of calls to both  */
 413 /* both functions is equal.                                             */
 414 GC_API void GC_enable GC_PROTO((void));
 415 
 416 /* Enable incremental/generational collection.  */
 417 /* Not advisable unless dirty bits are          */
 418 /* available or most heap objects are           */
 419 /* pointerfree(atomic) or immutable.            */
 420 /* Don't use in leak finding mode.              */
 421 /* Ignored if GC_dont_gc is true.               */
 422 /* Only the generational piece of this is       */
 423 /* functional if GC_parallel is TRUE            */
 424 /* or if GC_time_limit is GC_TIME_UNLIMITED.    */
 425 /* Causes GC_local_gcj_malloc() to revert to    */
 426 /* locked allocation.  Must be called           */
 427 /* before any GC_local_gcj_malloc() calls.      */
 428 GC_API void GC_enable_incremental GC_PROTO((void));
 429 
 430 /* Does incremental mode write-protect pages?  Returns zero or  */
 431 /* more of the following, or'ed together:                       */
 432 #define GC_PROTECTS_POINTER_HEAP  1 /* May protect non-atomic objs.     */
 433 #define GC_PROTECTS_PTRFREE_HEAP  2
 434 #define GC_PROTECTS_STATIC_DATA   4 /* Curently never.                  */
 435 #define GC_PROTECTS_STACK         8 /* Probably impractical.            */
 436 
 437 #define GC_PROTECTS_NONE 0
 438 GC_API int GC_incremental_protection_needs GC_PROTO((void));
 439 
 440 /* Perform some garbage collection work, if appropriate.        */
 441 /* Return 0 if there is no more work to be done.                */
 442 /* Typically performs an amount of work corresponding roughly   */
 443 /* to marking from one page.  May do more work if further       */
 444 /* progress requires it, e.g. if incremental collection is      */
 445 /* disabled.  It is reasonable to call this in a wait loop      */
 446 /* until it returns 0.                                          */
 447 GC_API int GC_collect_a_little GC_PROTO((void));
 448 
 449 /* Allocate an object of size lb bytes.  The client guarantees that     */
 450 /* as long as the object is live, it will be referenced by a pointer    */
 451 /* that points to somewhere within the first 256 bytes of the object.   */
 452 /* (This should normally be declared volatile to prevent the compiler   */
 453 /* from invalidating this assertion.)  This routine is only useful      */
 454 /* if a large array is being allocated.  It reduces the chance of       */
 455 /* accidentally retaining such an array as a result of scanning an      */
 456 /* integer that happens to be an address inside the array.  (Actually,  */
 457 /* it reduces the chance of the allocator not finding space for such    */
 458 /* an array, since it will try hard to avoid introducing such a false   */
 459 /* reference.)  On a SunOS 4.X or MS Windows system this is recommended */
 460 /* for arrays likely to be larger than 100K or so.  For other systems,  */
 461 /* or if the collector is not configured to recognize all interior      */
 462 /* pointers, the threshold is normally much higher.                     */
 463 GC_API GC_PTR GC_malloc_ignore_off_page GC_PROTO((size_t lb));
 464 GC_API GC_PTR GC_malloc_atomic_ignore_off_page GC_PROTO((size_t lb));
 465 
 466 #if defined(__sgi) && !defined(__GNUC__) && _COMPILER_VERSION >= 720
 467 #   define GC_ADD_CALLER
 468 #   define GC_RETURN_ADDR (GC_word)__return_address
 469 #endif
 470 
 471 #ifdef __linux__
 472 # include <features.h>
 473 # if (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 1 || __GLIBC__ > 2) \
 474      && !defined(__ia64__)
 475 #   ifndef GC_HAVE_BUILTIN_BACKTRACE
 476 #     define GC_HAVE_BUILTIN_BACKTRACE
 477 #   endif
 478 # endif
 479 # if defined(__i386__) || defined(__x86_64__)
 480 #   define GC_CAN_SAVE_CALL_STACKS
 481 # endif
 482 #endif
 483 
 484 #if defined(GC_HAVE_BUILTIN_BACKTRACE) && !defined(GC_CAN_SAVE_CALL_STACKS)
 485 # define GC_CAN_SAVE_CALL_STACKS
 486 #endif
 487 
 488 #if defined(__sparc__)
 489 #   define GC_CAN_SAVE_CALL_STACKS
 490 #endif
 491 
 492 /* If we're on an a platform on which we can't save call stacks, but    */
 493 /* gcc is normally used, we go ahead and define GC_ADD_CALLER.          */
 494 /* We make this decision independent of whether gcc is actually being   */
 495 /* used, in order to keep the interface consistent, and allow mixing    */
 496 /* of compilers.                                                        */
 497 /* This may also be desirable if it is possible but expensive to        */
 498 /* retrieve the call chain.                                             */
 499 #if (defined(__linux__) || defined(__NetBSD__) || defined(__OpenBSD__) \
 500      || defined(__FreeBSD__)) & !defined(GC_CAN_SAVE_CALL_STACKS)
 501 # define GC_ADD_CALLER
 502 # if __GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95) 
 503     /* gcc knows how to retrieve return address, but we don't know */
 504     /* how to generate call stacks.                                */
 505 #   define GC_RETURN_ADDR (GC_word)__builtin_return_address(0)
 506 # else
 507     /* Just pass 0 for gcc compatibility. */
 508 #   define GC_RETURN_ADDR 0
 509 # endif
 510 #endif
 511 
 512 #ifdef GC_ADD_CALLER
 513 #  define GC_EXTRAS GC_RETURN_ADDR, __FILE__, __LINE__
 514 #  define GC_EXTRA_PARAMS GC_word ra, GC_CONST char * s, int i
 515 #else
 516 #  define GC_EXTRAS __FILE__, __LINE__
 517 #  define GC_EXTRA_PARAMS GC_CONST char * s, int i
 518 #endif
 519 
 520 /* Debugging (annotated) allocation.  GC_gcollect will check            */
 521 /* objects allocated in this way for overwrites, etc.                   */
 522 GC_API GC_PTR GC_debug_malloc
 523         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 524 GC_API GC_PTR GC_debug_malloc_atomic
 525         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 526 GC_API GC_PTR GC_debug_malloc_uncollectable
 527         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 528 GC_API GC_PTR GC_debug_malloc_stubborn
 529         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 530 GC_API GC_PTR GC_debug_malloc_ignore_off_page
 531         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 532 GC_API GC_PTR GC_debug_malloc_atomic_ignore_off_page
 533         GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
 534 GC_API void GC_debug_free GC_PROTO((GC_PTR object_addr));
 535 GC_API GC_PTR GC_debug_realloc
 536         GC_PROTO((GC_PTR old_object, size_t new_size_in_bytes,
 537                   GC_EXTRA_PARAMS));
 538 GC_API void GC_debug_change_stubborn GC_PROTO((GC_PTR));
 539 GC_API void GC_debug_end_stubborn_change GC_PROTO((GC_PTR));
 540 
 541 /* Routines that allocate objects with debug information (like the      */
 542 /* above), but just fill in dummy file and line number information.     */
 543 /* Thus they can serve as drop-in malloc/realloc replacements.  This    */
 544 /* can be useful for two reasons:                                       */
 545 /* 1) It allows the collector to be built with DBG_HDRS_ALL defined     */
 546 /*    even if some allocation calls come from 3rd party libraries       */
 547 /*    that can't be recompiled.                                         */
 548 /* 2) On some platforms, the file and line information is redundant,    */
 549 /*    since it can be reconstructed from a stack trace.  On such        */
 550 /*    platforms it may be more convenient not to recompile, e.g. for    */
 551 /*    leak detection.  This can be accomplished by instructing the      */
 552 /*    linker to replace malloc/realloc with these.                      */
 553 GC_API GC_PTR GC_debug_malloc_replacement GC_PROTO((size_t size_in_bytes));
 554 GC_API GC_PTR GC_debug_realloc_replacement
 555               GC_PROTO((GC_PTR object_addr, size_t size_in_bytes));
 556                                  
 557 # ifdef GC_DEBUG
 558 #   define GC_MALLOC(sz) GC_debug_malloc(sz, GC_EXTRAS)
 559 #   define GC_MALLOC_ATOMIC(sz) GC_debug_malloc_atomic(sz, GC_EXTRAS)
 560 #   define GC_MALLOC_UNCOLLECTABLE(sz) \
 561                         GC_debug_malloc_uncollectable(sz, GC_EXTRAS)
 562 #   define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
 563                         GC_debug_malloc_ignore_off_page(sz, GC_EXTRAS)
 564 #   define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
 565                         GC_debug_malloc_atomic_ignore_off_page(sz, GC_EXTRAS)
 566 #   define GC_REALLOC(old, sz) GC_debug_realloc(old, sz, GC_EXTRAS)
 567 #   define GC_FREE(p) GC_debug_free(p)
 568 #   define GC_REGISTER_FINALIZER(p, f, d, of, od) \
 569         GC_debug_register_finalizer(p, f, d, of, od)
 570 #   define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
 571         GC_debug_register_finalizer_ignore_self(p, f, d, of, od)
 572 #   define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
 573         GC_debug_register_finalizer_no_order(p, f, d, of, od)
 574 #   define GC_MALLOC_STUBBORN(sz) GC_debug_malloc_stubborn(sz, GC_EXTRAS);
 575 #   define GC_CHANGE_STUBBORN(p) GC_debug_change_stubborn(p)
 576 #   define GC_END_STUBBORN_CHANGE(p) GC_debug_end_stubborn_change(p)
 577 #   define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
 578         GC_general_register_disappearing_link(link, GC_base(obj))
 579 #   define GC_REGISTER_DISPLACEMENT(n) GC_debug_register_displacement(n)
 580 # else
 581 #   define GC_MALLOC(sz) GC_malloc(sz)
 582 #   define GC_MALLOC_ATOMIC(sz) GC_malloc_atomic(sz)
 583 #   define GC_MALLOC_UNCOLLECTABLE(sz) GC_malloc_uncollectable(sz)
 584 #   define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
 585                         GC_malloc_ignore_off_page(sz)
 586 #   define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
 587                         GC_malloc_atomic_ignore_off_page(sz)
 588 #   define GC_REALLOC(old, sz) GC_realloc(old, sz)
 589 #   define GC_FREE(p) GC_free(p)
 590 #   define GC_REGISTER_FINALIZER(p, f, d, of, od) \
 591         GC_register_finalizer(p, f, d, of, od)
 592 #   define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
 593         GC_register_finalizer_ignore_self(p, f, d, of, od)
 594 #   define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
 595         GC_register_finalizer_no_order(p, f, d, of, od)
 596 #   define GC_MALLOC_STUBBORN(sz) GC_malloc_stubborn(sz)
 597 #   define GC_CHANGE_STUBBORN(p) GC_change_stubborn(p)
 598 #   define GC_END_STUBBORN_CHANGE(p) GC_end_stubborn_change(p)
 599 #   define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
 600         GC_general_register_disappearing_link(link, obj)
 601 #   define GC_REGISTER_DISPLACEMENT(n) GC_register_displacement(n)
 602 # endif
 603 /* The following are included because they are often convenient, and    */
 604 /* reduce the chance for a misspecifed size argument.  But calls may    */
 605 /* expand to something syntactically incorrect if t is a complicated    */
 606 /* type expression.                                                     */
 607 # define GC_NEW(t) (t *)GC_MALLOC(sizeof (t))
 608 # define GC_NEW_ATOMIC(t) (t *)GC_MALLOC_ATOMIC(sizeof (t))
 609 # define GC_NEW_STUBBORN(t) (t *)GC_MALLOC_STUBBORN(sizeof (t))
 610 # define GC_NEW_UNCOLLECTABLE(t) (t *)GC_MALLOC_UNCOLLECTABLE(sizeof (t))
 611 
 612 /* Finalization.  Some of these primitives are grossly unsafe.          */
 613 /* The idea is to make them both cheap, and sufficient to build         */
 614 /* a safer layer, closer to Modula-3, Java, or PCedar finalization.     */
 615 /* The interface represents my conclusions from a long discussion       */
 616 /* with Alan Demers, Dan Greene, Carl Hauser, Barry Hayes,              */
 617 /* Christian Jacobi, and Russ Atkinson.  It's not perfect, and          */
 618 /* probably nobody else agrees with it.     Hans-J. Boehm  3/13/92      */
 619 typedef void (*GC_finalization_proc)
 620         GC_PROTO((GC_PTR obj, GC_PTR client_data));
 621 
 622 GC_API void GC_register_finalizer
 623         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 624                   GC_finalization_proc *ofn, GC_PTR *ocd));
 625 GC_API void GC_debug_register_finalizer
 626         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 627                   GC_finalization_proc *ofn, GC_PTR *ocd));
 628         /* When obj is no longer accessible, invoke             */
 629         /* (*fn)(obj, cd).  If a and b are inaccessible, and    */
 630         /* a points to b (after disappearing links have been    */
 631         /* made to disappear), then only a will be              */
 632         /* finalized.  (If this does not create any new         */
 633         /* pointers to b, then b will be finalized after the    */
 634         /* next collection.)  Any finalizable object that       */
 635         /* is reachable from itself by following one or more    */
 636         /* pointers will not be finalized (or collected).       */
 637         /* Thus cycles involving finalizable objects should     */
 638         /* be avoided, or broken by disappearing links.         */
 639         /* All but the last finalizer registered for an object  */
 640         /* is ignored.                                          */
 641         /* Finalization may be removed by passing 0 as fn.      */
 642         /* Finalizers are implicitly unregistered just before   */
 643         /* they are invoked.                                    */
 644         /* The old finalizer and client data are stored in      */
 645         /* *ofn and *ocd.                                       */ 
 646         /* Fn is never invoked on an accessible object,         */
 647         /* provided hidden pointers are converted to real       */
 648         /* pointers only if the allocation lock is held, and    */
 649         /* such conversions are not performed by finalization   */
 650         /* routines.                                            */
 651         /* If GC_register_finalizer is aborted as a result of   */
 652         /* a signal, the object may be left with no             */
 653         /* finalization, even if neither the old nor new        */
 654         /* finalizer were NULL.                                 */
 655         /* Obj should be the nonNULL starting address of an     */
 656         /* object allocated by GC_malloc or friends.            */
 657         /* Note that any garbage collectable object referenced  */
 658         /* by cd will be considered accessible until the        */
 659         /* finalizer is invoked.                                */
 660 
 661 /* Another versions of the above follow.  It ignores            */
 662 /* self-cycles, i.e. pointers from a finalizable object to      */
 663 /* itself.  There is a stylistic argument that this is wrong,   */
 664 /* but it's unavoidable for C++, since the compiler may         */
 665 /* silently introduce these.  It's also benign in that specific */
 666 /* case.  And it helps if finalizable objects are split to      */
 667 /* avoid cycles.                                                */
 668 /* Note that cd will still be viewed as accessible, even if it  */
 669 /* refers to the object itself.                                 */
 670 GC_API void GC_register_finalizer_ignore_self
 671         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 672                   GC_finalization_proc *ofn, GC_PTR *ocd));
 673 GC_API void GC_debug_register_finalizer_ignore_self
 674         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 675                   GC_finalization_proc *ofn, GC_PTR *ocd));
 676 
 677 /* Another version of the above.  It ignores all cycles.        */
 678 /* It should probably only be used by Java implementations.     */
 679 /* Note that cd will still be viewed as accessible, even if it  */
 680 /* refers to the object itself.                                 */
 681 GC_API void GC_register_finalizer_no_order
 682         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 683                   GC_finalization_proc *ofn, GC_PTR *ocd));
 684 GC_API void GC_debug_register_finalizer_no_order
 685         GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
 686                   GC_finalization_proc *ofn, GC_PTR *ocd));
 687 
 688 
 689 /* The following routine may be used to break cycles between    */
 690 /* finalizable objects, thus causing cyclic finalizable         */
 691 /* objects to be finalized in the correct order.  Standard      */
 692 /* use involves calling GC_register_disappearing_link(&p),      */
 693 /* where p is a pointer that is not followed by finalization    */
 694 /* code, and should not be considered in determining            */
 695 /* finalization order.                                          */
 696 GC_API int GC_register_disappearing_link GC_PROTO((GC_PTR * /* link */));
 697         /* Link should point to a field of a heap allocated     */
 698         /* object obj.  *link will be cleared when obj is       */
 699         /* found to be inaccessible.  This happens BEFORE any   */
 700         /* finalization code is invoked, and BEFORE any         */
 701         /* decisions about finalization order are made.         */
 702         /* This is useful in telling the finalizer that         */
 703         /* some pointers are not essential for proper           */
 704         /* finalization.  This may avoid finalization cycles.   */
 705         /* Note that obj may be resurrected by another          */
 706         /* finalizer, and thus the clearing of *link may        */
 707         /* be visible to non-finalization code.                 */
 708         /* There's an argument that an arbitrary action should  */
 709         /* be allowed here, instead of just clearing a pointer. */
 710         /* But this causes problems if that action alters, or   */
 711         /* examines connectivity.                               */
 712         /* Returns 1 if link was already registered, 0          */
 713         /* otherwise.                                           */
 714         /* Only exists for backward compatibility.  See below:  */
 715         
 716 GC_API int GC_general_register_disappearing_link
 717         GC_PROTO((GC_PTR * /* link */, GC_PTR obj));
 718         /* A slight generalization of the above. *link is       */
 719         /* cleared when obj first becomes inaccessible.  This   */
 720         /* can be used to implement weak pointers easily and    */
 721         /* safely. Typically link will point to a location      */
 722         /* holding a disguised pointer to obj.  (A pointer      */
 723         /* inside an "atomic" object is effectively             */
 724         /* disguised.)   In this way soft                       */
 725         /* pointers are broken before any object                */
 726         /* reachable from them are finalized.  Each link        */
 727         /* May be registered only once, i.e. with one obj       */
 728         /* value.  This was added after a long email discussion */
 729         /* with John Ellis.                                     */
 730         /* Obj must be a pointer to the first word of an object */
 731         /* we allocated.  It is unsafe to explicitly deallocate */
 732         /* the object containing link.  Explicitly deallocating */
 733         /* obj may or may not cause link to eventually be       */
 734         /* cleared.                                             */
 735 GC_API int GC_unregister_disappearing_link GC_PROTO((GC_PTR * /* link */));
 736         /* Returns 0 if link was not actually registered.       */
 737         /* Undoes a registration by either of the above two     */
 738         /* routines.                                            */
 739 
 740 /* Returns !=0  if GC_invoke_finalizers has something to do.            */
 741 GC_API int GC_should_invoke_finalizers GC_PROTO((void));
 742 
 743 GC_API int GC_invoke_finalizers GC_PROTO((void));
 744         /* Run finalizers for all objects that are ready to     */
 745         /* be finalized.  Return the number of finalizers       */
 746         /* that were run.  Normally this is also called         */
 747         /* implicitly during some allocations.  If              */
 748         /* GC-finalize_on_demand is nonzero, it must be called  */
 749         /* explicitly.                                          */
 750 
 751 /* GC_set_warn_proc can be used to redirect or filter warning messages. */
 752 /* p may not be a NULL pointer.                                         */
 753 typedef void (*GC_warn_proc) GC_PROTO((char *msg, GC_word arg));
 754 GC_API GC_warn_proc GC_set_warn_proc GC_PROTO((GC_warn_proc p));
 755     /* Returns old warning procedure.   */
 756 
 757 GC_API GC_word GC_set_free_space_divisor GC_PROTO((GC_word value));
 758     /* Set free_space_divisor.  See above for definition.       */
 759     /* Returns old value.                                       */
 760         
 761 /* The following is intended to be used by a higher level       */
 762 /* (e.g. Java-like) finalization facility.  It is expected      */
 763 /* that finalization code will arrange for hidden pointers to   */
 764 /* disappear.  Otherwise objects can be accessed after they     */
 765 /* have been collected.                                         */
 766 /* Note that putting pointers in atomic objects or in           */
 767 /* nonpointer slots of "typed" objects is equivalent to         */
 768 /* disguising them in this way, and may have other advantages.  */
 769 # if defined(I_HIDE_POINTERS) || defined(GC_I_HIDE_POINTERS)
 770     typedef GC_word GC_hidden_pointer;
 771 #   define HIDE_POINTER(p) (~(GC_hidden_pointer)(p))
 772 #   define REVEAL_POINTER(p) ((GC_PTR)(HIDE_POINTER(p)))
 773     /* Converting a hidden pointer to a real pointer requires verifying */
 774     /* that the object still exists.  This involves acquiring the       */
 775     /* allocator lock to avoid a race with the collector.               */
 776 # endif /* I_HIDE_POINTERS */
 777 
 778 typedef GC_PTR (*GC_fn_type) GC_PROTO((GC_PTR client_data));
 779 GC_API GC_PTR GC_call_with_alloc_lock
 780                 GC_PROTO((GC_fn_type fn, GC_PTR client_data));
 781 
 782 /* The following routines are primarily intended for use with a         */
 783 /* preprocessor which inserts calls to check C pointer arithmetic.      */
 784 /* They indicate failure by invoking the corresponding _print_proc.     */
 785 
 786 /* Check that p and q point to the same object.                 */
 787 /* Fail conspicuously if they don't.                            */
 788 /* Returns the first argument.                                  */
 789 /* Succeeds if neither p nor q points to the heap.              */
 790 /* May succeed if both p and q point to between heap objects.   */
 791 GC_API GC_PTR GC_same_obj GC_PROTO((GC_PTR p, GC_PTR q));
 792 
 793 /* Checked pointer pre- and post- increment operations.  Note that      */
 794 /* the second argument is in units of bytes, not multiples of the       */
 795 /* object size.  This should either be invoked from a macro, or the     */
 796 /* call should be automatically generated.                              */
 797 GC_API GC_PTR GC_pre_incr GC_PROTO((GC_PTR *p, size_t how_much));
 798 GC_API GC_PTR GC_post_incr GC_PROTO((GC_PTR *p, size_t how_much));
 799 
 800 /* Check that p is visible                                              */
 801 /* to the collector as a possibly pointer containing location.          */
 802 /* If it isn't fail conspicuously.                                      */
 803 /* Returns the argument in all cases.  May erroneously succeed          */
 804 /* in hard cases.  (This is intended for debugging use with             */
 805 /* untyped allocations.  The idea is that it should be possible, though */
 806 /* slow, to add such a call to all indirect pointer stores.)            */
 807 /* Currently useless for multithreaded worlds.                          */
 808 GC_API GC_PTR GC_is_visible GC_PROTO((GC_PTR p));
 809 
 810 /* Check that if p is a pointer to a heap page, then it points to       */
 811 /* a valid displacement within a heap object.                           */
 812 /* Fail conspicuously if this property does not hold.                   */
 813 /* Uninteresting with GC_all_interior_pointers.                         */
 814 /* Always returns its argument.                                         */
 815 GC_API GC_PTR GC_is_valid_displacement GC_PROTO((GC_PTR p));
 816 
 817 /* Safer, but slow, pointer addition.  Probably useful mainly with      */
 818 /* a preprocessor.  Useful only for heap pointers.                      */
 819 #ifdef GC_DEBUG
 820 #   define GC_PTR_ADD3(x, n, type_of_result) \
 821         ((type_of_result)GC_same_obj((x)+(n), (x)))
 822 #   define GC_PRE_INCR3(x, n, type_of_result) \
 823         ((type_of_result)GC_pre_incr(&(x), (n)*sizeof(*x))
 824 #   define GC_POST_INCR2(x, type_of_result) \
 825         ((type_of_result)GC_post_incr(&(x), sizeof(*x))
 826 #   ifdef __GNUC__
 827 #       define GC_PTR_ADD(x, n) \
 828             GC_PTR_ADD3(x, n, typeof(x))
 829 #       define GC_PRE_INCR(x, n) \
 830             GC_PRE_INCR3(x, n, typeof(x))
 831 #       define GC_POST_INCR(x, n) \
 832             GC_POST_INCR3(x, typeof(x))
 833 #   else
 834         /* We can't do this right without typeof, which ANSI    */
 835         /* decided was not sufficiently useful.  Repeatedly     */
 836         /* mentioning the arguments seems too dangerous to be   */
 837         /* useful.  So does not casting the result.             */
 838 #       define GC_PTR_ADD(x, n) ((x)+(n))
 839 #   endif
 840 #else   /* !GC_DEBUG */
 841 #   define GC_PTR_ADD3(x, n, type_of_result) ((x)+(n))
 842 #   define GC_PTR_ADD(x, n) ((x)+(n))
 843 #   define GC_PRE_INCR3(x, n, type_of_result) ((x) += (n))
 844 #   define GC_PRE_INCR(x, n) ((x) += (n))
 845 #   define GC_POST_INCR2(x, n, type_of_result) ((x)++)
 846 #   define GC_POST_INCR(x, n) ((x)++)
 847 #endif
 848 
 849 /* Safer assignment of a pointer to a nonstack location.        */
 850 #ifdef GC_DEBUG
 851 # if defined(__STDC__) || defined(_AIX)
 852 #   define GC_PTR_STORE(p, q) \
 853         (*(void **)GC_is_visible(p) = GC_is_valid_displacement(q))
 854 # else
 855 #   define GC_PTR_STORE(p, q) \
 856         (*(char **)GC_is_visible(p) = GC_is_valid_displacement(q))
 857 # endif
 858 #else /* !GC_DEBUG */
 859 #   define GC_PTR_STORE(p, q) *((p) = (q))
 860 #endif
 861 
 862 /* Functions called to report pointer checking errors */
 863 GC_API void (*GC_same_obj_print_proc) GC_PROTO((GC_PTR p, GC_PTR q));
 864 
 865 GC_API void (*GC_is_valid_displacement_print_proc)
 866         GC_PROTO((GC_PTR p));
 867 
 868 GC_API void (*GC_is_visible_print_proc)
 869         GC_PROTO((GC_PTR p));
 870 
 871 
 872 /* For pthread support, we generally need to intercept a number of      */
 873 /* thread library calls.  We do that here by macro defining them.       */
 874 
 875 #if !defined(GC_USE_LD_WRAP) && \
 876     (defined(GC_PTHREADS) || defined(GC_SOLARIS_THREADS))
 877 # include "gc_pthread_redirects.h"
 878 #endif
 879 
 880 # if defined(PCR) || defined(GC_SOLARIS_THREADS) || \
 881      defined(GC_PTHREADS) || defined(GC_WIN32_THREADS)
 882         /* Any flavor of threads except SRC_M3. */
 883 /* This returns a list of objects, linked through their first           */
 884 /* word.  Its use can greatly reduce lock contention problems, since    */
 885 /* the allocation lock can be acquired and released many fewer times.   */
 886 /* lb must be large enough to hold the pointer field.                   */
 887 /* It is used internally by gc_local_alloc.h, which provides a simpler  */
 888 /* programming interface on Linux.                                      */
 889 GC_PTR GC_malloc_many(size_t lb);
 890 #define GC_NEXT(p) (*(GC_PTR *)(p))     /* Retrieve the next element    */
 891                                         /* in returned list.            */
 892 extern void GC_thr_init();      /* Needed for Solaris/X86       */
 893 
 894 #endif /* THREADS && !SRC_M3 */
 895 
 896 #if defined(GC_WIN32_THREADS) && !defined(__CYGWIN32__) && !defined(__CYGWIN__)
 897 # include <windows.h>
 898 
 899   /*
 900    * All threads must be created using GC_CreateThread, so that they will be
 901    * recorded in the thread table.  For backwards compatibility, this is not
 902    * technically true if the GC is built as a dynamic library, since it can
 903    * and does then use DllMain to keep track of thread creations.  But new code
 904    * should be built to call GC_CreateThread.
 905    */
 906    GC_API HANDLE WINAPI GC_CreateThread(
 907       LPSECURITY_ATTRIBUTES lpThreadAttributes,
 908       DWORD dwStackSize, LPTHREAD_START_ROUTINE lpStartAddress,
 909       LPVOID lpParameter, DWORD dwCreationFlags, LPDWORD lpThreadId );
 910 
 911 # if defined(_WIN32_WCE)
 912   /*
 913    * win32_threads.c implements the real WinMain, which will start a new thread
 914    * to call GC_WinMain after initializing the garbage collector.
 915    */
 916   int WINAPI GC_WinMain(
 917       HINSTANCE hInstance,
 918       HINSTANCE hPrevInstance,
 919       LPWSTR lpCmdLine,
 920       int nCmdShow );
 921 
 922 #  ifndef GC_BUILD
 923 #    define WinMain GC_WinMain
 924 #    define CreateThread GC_CreateThread
 925 #  endif
 926 # endif /* defined(_WIN32_WCE) */
 927 
 928 #endif /* defined(GC_WIN32_THREADS)  && !cygwin */
 929 
 930  /*
 931   * Fully portable code should call GC_INIT() from the main program
 932   * before making any other GC_ calls.  On most platforms this is a
 933   * no-op and the collector self-initializes.  But a number of platforms
 934   * make that too hard.
 935   */
 936 #if (defined(sparc) || defined(__sparc)) && defined(sun)
 937     /*
 938      * If you are planning on putting
 939      * the collector in a SunOS 5 dynamic library, you need to call GC_INIT()
 940      * from the statically loaded program section.
 941      * This circumvents a Solaris 2.X (X<=4) linker bug.
 942      */
 943 #   define GC_INIT() { extern end, etext; \
 944                        GC_noop(&end, &etext); }
 945 #else
 946 # if defined(__CYGWIN32__) || defined (_AIX)
 947     /*
 948      * Similarly gnu-win32 DLLs need explicit initialization from
 949      * the main program, as does AIX.
 950      */
 951 #   ifdef __CYGWIN32__
 952       extern int _data_start__[];
 953       extern int _data_end__[];
 954       extern int _bss_start__[];
 955       extern int _bss_end__[];
 956 #     define GC_MAX(x,y) ((x) > (y) ? (x) : (y))
 957 #     define GC_MIN(x,y) ((x) < (y) ? (x) : (y))
 958 #     define GC_DATASTART ((GC_PTR) GC_MIN(_data_start__, _bss_start__))
 959 #     define GC_DATAEND  ((GC_PTR) GC_MAX(_data_end__, _bss_end__))
 960 #     ifdef GC_DLL
 961 #       define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); }
 962 #     else
 963 #       define GC_INIT()
 964 #     endif
 965 #   endif
 966 #   if defined(_AIX)
 967       extern int _data[], _end[];
 968 #     define GC_DATASTART ((GC_PTR)((ulong)_data))
 969 #     define GC_DATAEND ((GC_PTR)((ulong)_end))
 970 #     define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); }
 971 #   endif
 972 # else
 973 #  if defined(__APPLE__) && defined(__MACH__) || defined(GC_WIN32_THREADS)
 974 #   define GC_INIT() { GC_init(); }
 975 #  else
 976 #   define GC_INIT()
 977 #  endif /* !__MACH && !GC_WIN32_THREADS */
 978 # endif /* !AIX && !cygwin */
 979 #endif /* !sparc */
 980 
 981 #if !defined(_WIN32_WCE) \
 982     && ((defined(_MSDOS) || defined(_MSC_VER)) && (_M_IX86 >= 300) \
 983         || defined(_WIN32) && !defined(__CYGWIN32__) && !defined(__CYGWIN__))
 984   /* win32S may not free all resources on process exit.  */
 985   /* This explicitly deallocates the heap.               */
 986     GC_API void GC_win32_free_heap ();
 987 #endif
 988 
 989 #if ( defined(_AMIGA) && !defined(GC_AMIGA_MAKINGLIB) )
 990   /* Allocation really goes through GC_amiga_allocwrapper_do */
 991 # include "gc_amiga_redirects.h"
 992 #endif
 993 
 994 #if defined(GC_REDIRECT_TO_LOCAL) && !defined(GC_LOCAL_ALLOC_H)
 995 #  include  "gc_local_alloc.h"
 996 #endif
 997 
 998 #ifdef __cplusplus
 999     }  /* end of extern "C" */
1000 #endif
1001 
1002 #endif /* _GC_H */

/* [<][>][^][v][top][bottom][index][help] */