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 * Copyright (C) 2007 Free Software Foundation, Inc
8 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
9 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
11 * Permission is hereby granted to use or copy this program
12 * for any purpose, provided the above notices are retained on all copies.
13 * Permission to modify the code and to distribute modified code is granted,
14 * provided the above notices are retained, and a notice that the code was
15 * modified is included with the above copyright notice.
19 * Note that this defines a large number of tuning hooks, which can
20 * safely be ignored in nearly all cases. For normal use it suffices
21 * to call only GC_MALLOC and perhaps GC_REALLOC.
22 * For better performance, also look at GC_MALLOC_ATOMIC, and
23 * GC_enable_incremental. If you need an action to be performed
24 * immediately before an object is collected, look at GC_register_finalizer.
25 * If you are using Solaris threads, look at the end of this file.
26 * Everything else is best ignored unless you encounter performance
34 # include "gc_version.h"
35 /* Define version numbers here to allow test on build machine */
36 /* for cross-builds. Note that this defines the header */
37 /* version number, which may or may not match that of the */
38 /* dynamic library. The GC_version variable can be used */
39 /* to obtain the latter. */
41 # include "gc_config_macros.h"
48 /* Define word and signed_word to be unsigned and signed types of the */
49 /* size as char * or void *. There seems to be no way to do this */
50 /* even semi-portably. The following is probably no better/worse */
51 /* than almost anything else. */
52 /* The ANSI standard suggests that size_t and ptr_diff_t might be */
53 /* better choices. But those had incorrect definitions on some older */
54 /* systems. Notably "typedef int size_t" is WRONG. */
56 typedef unsigned long GC_word;
57 typedef long GC_signed_word;
59 /* Win64 isn't really supported yet, but this is the first step. And */
60 /* it might cause error messages to show up in more plausible places. */
61 /* This needs basetsd.h, which is included by windows.h. */
62 typedef unsigned long long GC_word;
63 typedef long long GC_signed_word;
66 /* Public read-only variables */
68 GC_API GC_word GC_gc_no;/* Counter incremented per collection. */
69 /* Includes empty GCs at startup. */
71 GC_API int GC_parallel; /* GC is parallelized for performance on */
72 /* multiprocessors. Currently set only */
73 /* implicitly if collector is built with */
74 /* -DPARALLEL_MARK and if either: */
75 /* Env variable GC_NPROC is set to > 1, or */
76 /* GC_NPROC is not set and this is an MP. */
77 /* If GC_parallel is set, incremental */
78 /* collection is only partially functional, */
79 /* and may not be desirable. */
82 /* Public R/W variables */
84 GC_API void * (*GC_oom_fn) (size_t bytes_requested);
85 /* When there is insufficient memory to satisfy */
86 /* an allocation request, we return */
87 /* (*GC_oom_fn)(). By default this just */
89 /* If it returns, it must return 0 or a valid */
90 /* pointer to a previously allocated heap */
93 GC_API int GC_find_leak;
94 /* Do not actually garbage collect, but simply */
95 /* report inaccessible memory that was not */
96 /* deallocated with GC_free. Initial value */
97 /* is determined by FIND_LEAK macro. */
99 GC_API int GC_all_interior_pointers;
100 /* Arrange for pointers to object interiors to */
101 /* be recognized as valid. May not be changed */
102 /* after GC initialization. */
103 /* Initial value is determined by */
104 /* -DALL_INTERIOR_POINTERS. */
105 /* Unless DONT_ADD_BYTE_AT_END is defined, this */
106 /* also affects whether sizes are increased by */
107 /* at least a byte to allow "off the end" */
108 /* pointer recognition. */
109 /* MUST BE 0 or 1. */
111 GC_API int GC_finalize_on_demand;
112 /* If nonzero, finalizers will only be run in */
113 /* response to an explicit GC_invoke_finalizers */
114 /* call. The default is determined by whether */
115 /* the FINALIZE_ON_DEMAND macro is defined */
116 /* when the collector is built. */
118 GC_API int GC_java_finalization;
119 /* Mark objects reachable from finalizable */
120 /* objects in a separate postpass. This makes */
121 /* it a bit safer to use non-topologically- */
122 /* ordered finalization. Default value is */
123 /* determined by JAVA_FINALIZATION macro. */
124 /* Enables register_finalizer_unreachable to */
125 /* work correctly. */
127 GC_API void (* GC_finalizer_notifier)(void);
128 /* Invoked by the collector when there are */
129 /* objects to be finalized. Invoked at most */
130 /* once per GC cycle. Never invoked unless */
131 /* GC_finalize_on_demand is set. */
132 /* Typically this will notify a finalization */
133 /* thread, which will call GC_invoke_finalizers */
136 GC_API int GC_dont_gc; /* != 0 ==> Dont collect. In versions 6.2a1+, */
137 /* this overrides explicit GC_gcollect() calls. */
138 /* Used as a counter, so that nested enabling */
139 /* and disabling work correctly. Should */
140 /* normally be updated with GC_enable() and */
141 /* GC_disable() calls. */
142 /* Direct assignment to GC_dont_gc is */
145 GC_API int GC_dont_expand;
146 /* Dont expand heap unless explicitly requested */
149 GC_API int GC_use_entire_heap;
150 /* Causes the nonincremental collector to use the */
151 /* entire heap before collecting. This was the only */
152 /* option for GC versions < 5.0. This sometimes */
153 /* results in more large block fragmentation, since */
154 /* very larg blocks will tend to get broken up */
155 /* during each GC cycle. It is likely to result in a */
156 /* larger working set, but lower collection */
157 /* frequencies, and hence fewer instructions executed */
158 /* in the collector. */
160 GC_API int GC_full_freq; /* Number of partial collections between */
161 /* full collections. Matters only if */
162 /* GC_incremental is set. */
163 /* Full collections are also triggered if */
164 /* the collector detects a substantial */
165 /* increase in the number of in-use heap */
166 /* blocks. Values in the tens are now */
167 /* perfectly reasonable, unlike for */
168 /* earlier GC versions. */
170 GC_API GC_word GC_non_gc_bytes;
171 /* Bytes not considered candidates for collection. */
172 /* Used only to control scheduling of collections. */
173 /* Updated by GC_malloc_uncollectable and GC_free. */
176 GC_API int GC_no_dls;
177 /* Don't register dynamic library data segments. */
178 /* Wizards only. Should be used only if the */
179 /* application explicitly registers all roots. */
180 /* In Microsoft Windows environments, this will */
181 /* usually also prevent registration of the */
182 /* main data segment as part of the root set. */
184 GC_API GC_word GC_free_space_divisor;
185 /* We try to make sure that we allocate at */
186 /* least N/GC_free_space_divisor bytes between */
187 /* collections, where N is twice the number */
188 /* of traced bytes, plus the number of untraced */
189 /* bytes (bytes in "atomic" objects), plus */
190 /* a rough estimate of the root set size. */
191 /* N approximates GC tracing work per GC. */
192 /* Initially, GC_free_space_divisor = 3. */
193 /* Increasing its value will use less space */
194 /* but more collection time. Decreasing it */
195 /* will appreciably decrease collection time */
196 /* at the expense of space. */
198 GC_API GC_word GC_max_retries;
199 /* The maximum number of GCs attempted before */
200 /* reporting out of memory after heap */
201 /* expansion fails. Initially 0. */
204 GC_API char *GC_stackbottom; /* Cool end of user stack. */
205 /* May be set in the client prior to */
206 /* calling any GC_ routines. This */
207 /* avoids some overhead, and */
208 /* potentially some signals that can */
209 /* confuse debuggers. Otherwise the */
210 /* collector attempts to set it */
212 /* For multithreaded code, this is the */
213 /* cold end of the stack for the */
214 /* primordial thread. */
216 GC_API int GC_dont_precollect; /* Don't collect as part of */
217 /* initialization. Should be set only */
218 /* if the client wants a chance to */
219 /* manually initialize the root set */
220 /* before the first collection. */
221 /* Interferes with blacklisting. */
224 GC_API unsigned long GC_time_limit;
225 /* If incremental collection is enabled, */
226 /* We try to terminate collections */
227 /* after this many milliseconds. Not a */
228 /* hard time bound. Setting this to */
229 /* GC_TIME_UNLIMITED will essentially */
230 /* disable incremental collection while */
231 /* leaving generational collection */
233 # define GC_TIME_UNLIMITED 999999
234 /* Setting GC_time_limit to this value */
235 /* will disable the "pause time exceeded"*/
238 /* Public procedures */
240 /* Initialize the collector. Portable clients should call GC_INIT() from
241 * the main program instead.
243 GC_API void GC_init(void);
246 * general purpose allocation routines, with roughly malloc calling conv.
247 * The atomic versions promise that no relevant pointers are contained
248 * in the object. The nonatomic versions guarantee that the new object
249 * is cleared. GC_malloc_stubborn promises that no changes to the object
250 * will occur after GC_end_stubborn_change has been called on the
251 * result of GC_malloc_stubborn. GC_malloc_uncollectable allocates an object
252 * that is scanned for pointers to collectable objects, but is not itself
253 * collectable. The object is scanned even if it does not appear to
254 * be reachable. GC_malloc_uncollectable and GC_free called on the resulting
255 * object implicitly update GC_non_gc_bytes appropriately.
257 * Note that the GC_malloc_stubborn support is stubbed out by default
258 * starting in 6.0. GC_malloc_stubborn is an alias for GC_malloc unless
259 * the collector is built with STUBBORN_ALLOC defined.
261 GC_API void * GC_malloc(size_t size_in_bytes);
262 GC_API void * GC_malloc_atomic(size_t size_in_bytes);
263 GC_API char * GC_strdup (const char *str);
264 GC_API void * GC_malloc_uncollectable(size_t size_in_bytes);
265 GC_API void * GC_malloc_stubborn(size_t size_in_bytes);
267 /* The following is only defined if the library has been suitably */
269 GC_API void * GC_malloc_atomic_uncollectable(size_t size_in_bytes);
271 /* Explicitly deallocate an object. Dangerous if used incorrectly. */
272 /* Requires a pointer to the base of an object. */
273 /* If the argument is stubborn, it should not be changeable when freed. */
274 /* An object should not be enable for finalization when it is */
275 /* explicitly deallocated. */
276 /* GC_free(0) is a no-op, as required by ANSI C for free. */
277 GC_API void GC_free(void * object_addr);
280 * Stubborn objects may be changed only if the collector is explicitly informed.
281 * The collector is implicitly informed of coming change when such
282 * an object is first allocated. The following routines inform the
283 * collector that an object will no longer be changed, or that it will
284 * once again be changed. Only nonNIL pointer stores into the object
285 * are considered to be changes. The argument to GC_end_stubborn_change
286 * must be exacly the value returned by GC_malloc_stubborn or passed to
287 * GC_change_stubborn. (In the second case it may be an interior pointer
288 * within 512 bytes of the beginning of the objects.)
289 * There is a performance penalty for allowing more than
290 * one stubborn object to be changed at once, but it is acceptable to
291 * do so. The same applies to dropping stubborn objects that are still
294 GC_API void GC_change_stubborn(void *);
295 GC_API void GC_end_stubborn_change(void *);
297 /* Return a pointer to the base (lowest address) of an object given */
298 /* a pointer to a location within the object. */
299 /* I.e. map an interior pointer to the corresponding bas pointer. */
300 /* Note that with debugging allocation, this returns a pointer to the */
301 /* actual base of the object, i.e. the debug information, not to */
302 /* the base of the user object. */
303 /* Return 0 if displaced_pointer doesn't point to within a valid */
305 /* Note that a deallocated object in the garbage collected heap */
306 /* may be considered valid, even if it has been deallocated with */
308 GC_API void * GC_base(void * displaced_pointer);
310 /* Given a pointer to the base of an object, return its size in bytes. */
311 /* The returned size may be slightly larger than what was originally */
313 GC_API size_t GC_size(void * object_addr);
315 /* For compatibility with C library. This is occasionally faster than */
316 /* a malloc followed by a bcopy. But if you rely on that, either here */
317 /* or with the standard C library, your code is broken. In my */
318 /* opinion, it shouldn't have been invented, but now we're stuck. -HB */
319 /* The resulting object has the same kind as the original. */
320 /* If the argument is stubborn, the result will have changes enabled. */
321 /* It is an error to have changes enabled for the original object. */
322 /* Follows ANSI comventions for NULL old_object. */
323 GC_API void * GC_realloc(void * old_object, size_t new_size_in_bytes);
325 /* Explicitly increase the heap size. */
326 /* Returns 0 on failure, 1 on success. */
327 GC_API int GC_expand_hp(size_t number_of_bytes);
329 /* Limit the heap size to n bytes. Useful when you're debugging, */
330 /* especially on systems that don't handle running out of memory well. */
331 /* n == 0 ==> unbounded. This is the default. */
332 GC_API void GC_set_max_heap_size(GC_word n);
334 GC_API GC_word GC_get_max_heap_size(void);
336 /* Inform the collector that a certain section of statically allocated */
337 /* memory contains no pointers to garbage collected memory. Thus it */
338 /* need not be scanned. This is sometimes important if the application */
339 /* maps large read/write files into the address space, which could be */
340 /* mistaken for dynamic library data segments on some systems. */
341 GC_API void GC_exclude_static_roots(void * low_address,
342 void * high_address_plus_1);
344 /* Clear the set of root segments. Wizards only. */
345 GC_API void GC_clear_roots(void);
347 /* Add a root segment. Wizards only. */
348 GC_API void GC_add_roots(void * low_address, void * high_address_plus_1);
350 /* Remove a root segment. Wizards only. */
351 GC_API void GC_remove_roots(void * low_address, void * high_address_plus_1);
353 /* Add a displacement to the set of those considered valid by the */
354 /* collector. GC_register_displacement(n) means that if p was returned */
355 /* by GC_malloc, then (char *)p + n will be considered to be a valid */
356 /* pointer to p. N must be small and less than the size of p. */
357 /* (All pointers to the interior of objects from the stack are */
358 /* considered valid in any case. This applies to heap objects and */
360 /* Preferably, this should be called before any other GC procedures. */
361 /* Calling it later adds to the probability of excess memory */
363 /* This is a no-op if the collector has recognition of */
364 /* arbitrary interior pointers enabled, which is now the default. */
365 GC_API void GC_register_displacement(size_t n);
367 /* The following version should be used if any debugging allocation is */
369 GC_API void GC_debug_register_displacement(size_t n);
371 /* Explicitly trigger a full, world-stop collection. */
372 GC_API void GC_gcollect(void);
374 /* Trigger a full world-stopped collection. Abort the collection if */
375 /* and when stop_func returns a nonzero value. Stop_func will be */
376 /* called frequently, and should be reasonably fast. This works even */
377 /* if virtual dirty bits, and hence incremental collection is not */
378 /* available for this architecture. Collections can be aborted faster */
379 /* than normal pause times for incremental collection. However, */
380 /* aborted collections do no useful work; the next collection needs */
381 /* to start from the beginning. */
382 /* Return 0 if the collection was aborted, 1 if it succeeded. */
383 typedef int (* GC_stop_func)(void);
384 GC_API int GC_try_to_collect(GC_stop_func stop_func);
386 /* Return the number of bytes in the heap. Excludes collector private */
387 /* data structures. Includes empty blocks and fragmentation loss. */
388 /* Includes some pages that were allocated but never written. */
389 GC_API size_t GC_get_heap_size(void);
391 /* Return a lower bound on the number of free bytes in the heap. */
392 GC_API size_t GC_get_free_bytes(void);
394 /* Return the number of bytes allocated since the last collection. */
395 GC_API size_t GC_get_bytes_since_gc(void);
397 /* Return the total number of bytes allocated in this process. */
398 /* Never decreases, except due to wrapping. */
399 GC_API size_t GC_get_total_bytes(void);
401 /* Disable garbage collection. Even GC_gcollect calls will be */
403 GC_API void GC_disable(void);
405 /* Reenable garbage collection. GC_disable() and GC_enable() calls */
406 /* nest. Garbage collection is enabled if the number of calls to both */
407 /* both functions is equal. */
408 GC_API void GC_enable(void);
410 /* Enable incremental/generational collection. */
411 /* Not advisable unless dirty bits are */
412 /* available or most heap objects are */
413 /* pointerfree(atomic) or immutable. */
414 /* Don't use in leak finding mode. */
415 /* Ignored if GC_dont_gc is true. */
416 /* Only the generational piece of this is */
417 /* functional if GC_parallel is TRUE */
418 /* or if GC_time_limit is GC_TIME_UNLIMITED. */
419 /* Causes GC_local_gcj_malloc() to revert to */
420 /* locked allocation. Must be called */
421 /* before any GC_local_gcj_malloc() calls. */
422 /* For best performance, should be called as early as possible. */
423 /* On some platforms, calling it later may have adverse effects.*/
424 /* Safe to call before GC_INIT(). Includes a GC_init() call. */
425 GC_API void GC_enable_incremental(void);
427 /* Does incremental mode write-protect pages? Returns zero or */
428 /* more of the following, or'ed together: */
429 #define GC_PROTECTS_POINTER_HEAP 1 /* May protect non-atomic objs. */
430 #define GC_PROTECTS_PTRFREE_HEAP 2
431 #define GC_PROTECTS_STATIC_DATA 4 /* Currently never. */
432 #define GC_PROTECTS_STACK 8 /* Probably impractical. */
434 #define GC_PROTECTS_NONE 0
435 GC_API int GC_incremental_protection_needs(void);
437 /* Perform some garbage collection work, if appropriate. */
438 /* Return 0 if there is no more work to be done. */
439 /* Typically performs an amount of work corresponding roughly */
440 /* to marking from one page. May do more work if further */
441 /* progress requires it, e.g. if incremental collection is */
442 /* disabled. It is reasonable to call this in a wait loop */
443 /* until it returns 0. */
444 GC_API int GC_collect_a_little(void);
446 /* Allocate an object of size lb bytes. The client guarantees that */
447 /* as long as the object is live, it will be referenced by a pointer */
448 /* that points to somewhere within the first 256 bytes of the object. */
449 /* (This should normally be declared volatile to prevent the compiler */
450 /* from invalidating this assertion.) This routine is only useful */
451 /* if a large array is being allocated. It reduces the chance of */
452 /* accidentally retaining such an array as a result of scanning an */
453 /* integer that happens to be an address inside the array. (Actually, */
454 /* it reduces the chance of the allocator not finding space for such */
455 /* an array, since it will try hard to avoid introducing such a false */
456 /* reference.) On a SunOS 4.X or MS Windows system this is recommended */
457 /* for arrays likely to be larger than 100K or so. For other systems, */
458 /* or if the collector is not configured to recognize all interior */
459 /* pointers, the threshold is normally much higher. */
460 GC_API void * GC_malloc_ignore_off_page(size_t lb);
461 GC_API void * GC_malloc_atomic_ignore_off_page(size_t lb);
463 #if defined(__sgi) && !defined(__GNUC__) && _COMPILER_VERSION >= 720
464 # define GC_ADD_CALLER
465 # define GC_RETURN_ADDR (GC_word)__return_address
468 #if defined(__linux__) || defined(__GLIBC__)
469 # include <features.h>
470 # if (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 1 || __GLIBC__ > 2) \
471 && !defined(__ia64__) && !defined(__UCLIBC__)
472 # ifndef GC_HAVE_BUILTIN_BACKTRACE
473 /* # define GC_HAVE_BUILTIN_BACKTRACE */
476 # if defined(__i386__) || defined(__x86_64__)
477 # define GC_CAN_SAVE_CALL_STACKS
481 #if defined(_MSC_VER) && _MSC_VER >= 1200 /* version 12.0+ (MSVC 6.0+) */ \
483 # ifndef GC_HAVE_NO_BUILTIN_BACKTRACE
484 # define GC_HAVE_BUILTIN_BACKTRACE
488 #if defined(GC_HAVE_BUILTIN_BACKTRACE) && !defined(GC_CAN_SAVE_CALL_STACKS)
489 # define GC_CAN_SAVE_CALL_STACKS
492 #if defined(__sparc__)
493 # define GC_CAN_SAVE_CALL_STACKS
496 /* If we're on an a platform on which we can't save call stacks, but */
497 /* gcc is normally used, we go ahead and define GC_ADD_CALLER. */
498 /* We make this decision independent of whether gcc is actually being */
499 /* used, in order to keep the interface consistent, and allow mixing */
501 /* This may also be desirable if it is possible but expensive to */
502 /* retrieve the call chain. */
503 #if (defined(__linux__) || defined(__NetBSD__) || defined(__OpenBSD__) \
504 || defined(__FreeBSD__) || defined(__DragonFly__)) & !defined(GC_CAN_SAVE_CALL_STACKS)
505 # define GC_ADD_CALLER
506 # if __GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
507 /* gcc knows how to retrieve return address, but we don't know */
508 /* how to generate call stacks. */
509 # define GC_RETURN_ADDR (GC_word)__builtin_return_address(0)
511 /* Just pass 0 for gcc compatibility. */
512 # define GC_RETURN_ADDR 0
517 # define GC_EXTRAS GC_RETURN_ADDR, __FILE__, __LINE__
518 # define GC_EXTRA_PARAMS GC_word ra, const char * s, int i
520 # define GC_EXTRAS __FILE__, __LINE__
521 # define GC_EXTRA_PARAMS const char * s, int i
524 /* Debugging (annotated) allocation. GC_gcollect will check */
525 /* objects allocated in this way for overwrites, etc. */
526 GC_API void * GC_debug_malloc(size_t size_in_bytes, GC_EXTRA_PARAMS);
527 GC_API void * GC_debug_malloc_atomic(size_t size_in_bytes, GC_EXTRA_PARAMS);
528 GC_API char * GC_debug_strdup(const char *str, GC_EXTRA_PARAMS);
529 GC_API void * GC_debug_malloc_uncollectable
530 (size_t size_in_bytes, GC_EXTRA_PARAMS);
531 GC_API void * GC_debug_malloc_stubborn
532 (size_t size_in_bytes, GC_EXTRA_PARAMS);
533 GC_API void * GC_debug_malloc_ignore_off_page
534 (size_t size_in_bytes, GC_EXTRA_PARAMS);
535 GC_API void * GC_debug_malloc_atomic_ignore_off_page
536 (size_t size_in_bytes, GC_EXTRA_PARAMS);
537 GC_API void GC_debug_free (void * object_addr);
538 GC_API void * GC_debug_realloc
539 (void * old_object, size_t new_size_in_bytes, GC_EXTRA_PARAMS);
540 GC_API void GC_debug_change_stubborn(void *);
541 GC_API void GC_debug_end_stubborn_change(void *);
543 /* Routines that allocate objects with debug information (like the */
544 /* above), but just fill in dummy file and line number information. */
545 /* Thus they can serve as drop-in malloc/realloc replacements. This */
546 /* can be useful for two reasons: */
547 /* 1) It allows the collector to be built with DBG_HDRS_ALL defined */
548 /* even if some allocation calls come from 3rd party libraries */
549 /* that can't be recompiled. */
550 /* 2) On some platforms, the file and line information is redundant, */
551 /* since it can be reconstructed from a stack trace. On such */
552 /* platforms it may be more convenient not to recompile, e.g. for */
553 /* leak detection. This can be accomplished by instructing the */
554 /* linker to replace malloc/realloc with these. */
555 GC_API void * GC_debug_malloc_replacement (size_t size_in_bytes);
556 GC_API void * GC_debug_realloc_replacement
557 (void * object_addr, size_t size_in_bytes);
560 # define GC_MALLOC(sz) GC_debug_malloc(sz, GC_EXTRAS)
561 # define GC_MALLOC_ATOMIC(sz) GC_debug_malloc_atomic(sz, GC_EXTRAS)
562 # define GC_STRDUP(s) GC_debug_strdup((s), GC_EXTRAS)
563 # define GC_MALLOC_UNCOLLECTABLE(sz) \
564 GC_debug_malloc_uncollectable(sz, GC_EXTRAS)
565 # define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
566 GC_debug_malloc_ignore_off_page(sz, GC_EXTRAS)
567 # define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
568 GC_debug_malloc_atomic_ignore_off_page(sz, GC_EXTRAS)
569 # define GC_REALLOC(old, sz) GC_debug_realloc(old, sz, GC_EXTRAS)
570 # define GC_FREE(p) GC_debug_free(p)
571 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
572 GC_debug_register_finalizer(p, f, d, of, od)
573 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
574 GC_debug_register_finalizer_ignore_self(p, f, d, of, od)
575 # define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
576 GC_debug_register_finalizer_no_order(p, f, d, of, od)
577 # define GC_REGISTER_FINALIZER_UNREACHABLE(p, f, d, of, od) \
578 GC_debug_register_finalizer_unreachable(p, f, d, of, od)
579 # define GC_MALLOC_STUBBORN(sz) GC_debug_malloc_stubborn(sz, GC_EXTRAS);
580 # define GC_CHANGE_STUBBORN(p) GC_debug_change_stubborn(p)
581 # define GC_END_STUBBORN_CHANGE(p) GC_debug_end_stubborn_change(p)
582 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
583 GC_general_register_disappearing_link(link, GC_base(obj))
584 # define GC_REGISTER_DISPLACEMENT(n) GC_debug_register_displacement(n)
586 # define GC_MALLOC(sz) GC_malloc(sz)
587 # define GC_MALLOC_ATOMIC(sz) GC_malloc_atomic(sz)
588 # define GC_STRDUP(s) GC_strdup(s)
589 # define GC_MALLOC_UNCOLLECTABLE(sz) GC_malloc_uncollectable(sz)
590 # define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
591 GC_malloc_ignore_off_page(sz)
592 # define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
593 GC_malloc_atomic_ignore_off_page(sz)
594 # define GC_REALLOC(old, sz) GC_realloc(old, sz)
595 # define GC_FREE(p) GC_free(p)
596 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
597 GC_register_finalizer(p, f, d, of, od)
598 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
599 GC_register_finalizer_ignore_self(p, f, d, of, od)
600 # define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
601 GC_register_finalizer_no_order(p, f, d, of, od)
602 # define GC_REGISTER_FINALIZER_UNREACHABLE(p, f, d, of, od) \
603 GC_register_finalizer_unreachable(p, f, d, of, od)
604 # define GC_MALLOC_STUBBORN(sz) GC_malloc_stubborn(sz)
605 # define GC_CHANGE_STUBBORN(p) GC_change_stubborn(p)
606 # define GC_END_STUBBORN_CHANGE(p) GC_end_stubborn_change(p)
607 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
608 GC_general_register_disappearing_link(link, obj)
609 # define GC_REGISTER_DISPLACEMENT(n) GC_register_displacement(n)
611 /* The following are included because they are often convenient, and */
612 /* reduce the chance for a misspecifed size argument. But calls may */
613 /* expand to something syntactically incorrect if t is a complicated */
614 /* type expression. */
615 # define GC_NEW(t) (t *)GC_MALLOC(sizeof (t))
616 # define GC_NEW_ATOMIC(t) (t *)GC_MALLOC_ATOMIC(sizeof (t))
617 # define GC_NEW_STUBBORN(t) (t *)GC_MALLOC_STUBBORN(sizeof (t))
618 # define GC_NEW_UNCOLLECTABLE(t) (t *)GC_MALLOC_UNCOLLECTABLE(sizeof (t))
620 /* Finalization. Some of these primitives are grossly unsafe. */
621 /* The idea is to make them both cheap, and sufficient to build */
622 /* a safer layer, closer to Modula-3, Java, or PCedar finalization. */
623 /* The interface represents my conclusions from a long discussion */
624 /* with Alan Demers, Dan Greene, Carl Hauser, Barry Hayes, */
625 /* Christian Jacobi, and Russ Atkinson. It's not perfect, and */
626 /* probably nobody else agrees with it. Hans-J. Boehm 3/13/92 */
627 typedef void (*GC_finalization_proc) (void * obj, void * client_data);
629 GC_API void GC_register_finalizer(void * obj, GC_finalization_proc fn,
630 void * cd, GC_finalization_proc *ofn,
632 GC_API void GC_debug_register_finalizer
633 (void * obj, GC_finalization_proc fn, void * cd,
634 GC_finalization_proc *ofn, void * *ocd);
635 /* When obj is no longer accessible, invoke */
636 /* (*fn)(obj, cd). If a and b are inaccessible, and */
637 /* a points to b (after disappearing links have been */
638 /* made to disappear), then only a will be */
639 /* finalized. (If this does not create any new */
640 /* pointers to b, then b will be finalized after the */
641 /* next collection.) Any finalizable object that */
642 /* is reachable from itself by following one or more */
643 /* pointers will not be finalized (or collected). */
644 /* Thus cycles involving finalizable objects should */
645 /* be avoided, or broken by disappearing links. */
646 /* All but the last finalizer registered for an object */
648 /* Finalization may be removed by passing 0 as fn. */
649 /* Finalizers are implicitly unregistered just before */
650 /* they are invoked. */
651 /* The old finalizer and client data are stored in */
653 /* Fn is never invoked on an accessible object, */
654 /* provided hidden pointers are converted to real */
655 /* pointers only if the allocation lock is held, and */
656 /* such conversions are not performed by finalization */
658 /* If GC_register_finalizer is aborted as a result of */
659 /* a signal, the object may be left with no */
660 /* finalization, even if neither the old nor new */
661 /* finalizer were NULL. */
662 /* Obj should be the nonNULL starting address of an */
663 /* object allocated by GC_malloc or friends. */
664 /* Note that any garbage collectable object referenced */
665 /* by cd will be considered accessible until the */
666 /* finalizer is invoked. */
668 /* Another versions of the above follow. It ignores */
669 /* self-cycles, i.e. pointers from a finalizable object to */
670 /* itself. There is a stylistic argument that this is wrong, */
671 /* but it's unavoidable for C++, since the compiler may */
672 /* silently introduce these. It's also benign in that specific */
673 /* case. And it helps if finalizable objects are split to */
675 /* Note that cd will still be viewed as accessible, even if it */
676 /* refers to the object itself. */
677 GC_API void GC_register_finalizer_ignore_self
678 (void * obj, GC_finalization_proc fn, void * cd,
679 GC_finalization_proc *ofn, void * *ocd);
680 GC_API void GC_debug_register_finalizer_ignore_self
681 (void * obj, GC_finalization_proc fn, void * cd,
682 GC_finalization_proc *ofn, void * *ocd);
684 /* Another version of the above. It ignores all cycles. */
685 /* It should probably only be used by Java implementations. */
686 /* Note that cd will still be viewed as accessible, even if it */
687 /* refers to the object itself. */
688 GC_API void GC_register_finalizer_no_order
689 (void * obj, GC_finalization_proc fn, void * cd,
690 GC_finalization_proc *ofn, void * *ocd);
691 GC_API void GC_debug_register_finalizer_no_order
692 (void * obj, GC_finalization_proc fn, void * cd,
693 GC_finalization_proc *ofn, void * *ocd);
695 /* This is a special finalizer that is useful when an object's */
696 /* finalizer must be run when the object is known to be no */
697 /* longer reachable, not even from other finalizable objects. */
698 /* It behaves like "normal" finalization, except that the */
699 /* finalizer is not run while the object is reachable from */
700 /* other objects specifying unordered finalization. */
701 /* Effectively it allows an object referenced, possibly */
702 /* indirectly, from an unordered finalizable object to override */
703 /* the unordered finalization request. */
704 /* This can be used in combination with finalizer_no_order so */
705 /* as to release resources that must not be released while an */
706 /* object can still be brought back to life by other */
708 /* Only works if GC_java_finalization is set. Probably only */
709 /* of interest when implementing a language that requires */
710 /* unordered finalization (e.g. Java, C#). */
711 GC_API void GC_register_finalizer_unreachable
712 (void * obj, GC_finalization_proc fn, void * cd,
713 GC_finalization_proc *ofn, void * *ocd);
714 GC_API void GC_debug_register_finalizer_unreachable
715 (void * obj, GC_finalization_proc fn, void * cd,
716 GC_finalization_proc *ofn, void * *ocd);
718 /* The following routine may be used to break cycles between */
719 /* finalizable objects, thus causing cyclic finalizable */
720 /* objects to be finalized in the correct order. Standard */
721 /* use involves calling GC_register_disappearing_link(&p), */
722 /* where p is a pointer that is not followed by finalization */
723 /* code, and should not be considered in determining */
724 /* finalization order. */
725 GC_API int GC_register_disappearing_link(void * * link );
726 /* Link should point to a field of a heap allocated */
727 /* object obj. *link will be cleared when obj is */
728 /* found to be inaccessible. This happens BEFORE any */
729 /* finalization code is invoked, and BEFORE any */
730 /* decisions about finalization order are made. */
731 /* This is useful in telling the finalizer that */
732 /* some pointers are not essential for proper */
733 /* finalization. This may avoid finalization cycles. */
734 /* Note that obj may be resurrected by another */
735 /* finalizer, and thus the clearing of *link may */
736 /* be visible to non-finalization code. */
737 /* There's an argument that an arbitrary action should */
738 /* be allowed here, instead of just clearing a pointer. */
739 /* But this causes problems if that action alters, or */
740 /* examines connectivity. */
741 /* Returns 1 if link was already registered, 0 if */
742 /* registration succeeded, 2 if it failed for lack of */
743 /* memory, and GC_oom_fn did not handle the problem. */
744 /* Only exists for backward compatibility. See below: */
746 GC_API int GC_general_register_disappearing_link (void * * link, void * obj);
747 /* A slight generalization of the above. *link is */
748 /* cleared when obj first becomes inaccessible. This */
749 /* can be used to implement weak pointers easily and */
750 /* safely. Typically link will point to a location */
751 /* holding a disguised pointer to obj. (A pointer */
752 /* inside an "atomic" object is effectively */
753 /* disguised.) In this way soft */
754 /* pointers are broken before any object */
755 /* reachable from them are finalized. Each link */
756 /* May be registered only once, i.e. with one obj */
757 /* value. This was added after a long email discussion */
758 /* with John Ellis. */
759 /* Obj must be a pointer to the first word of an object */
760 /* we allocated. It is unsafe to explicitly deallocate */
761 /* the object containing link. Explicitly deallocating */
762 /* obj may or may not cause link to eventually be */
764 /* This can be used to implement certain types of */
765 /* weak pointers. Note however that this generally */
766 /* requires that thje allocation lock is held (see */
767 /* GC_call_with_allock_lock() below) when the disguised */
768 /* pointer is accessed. Otherwise a strong pointer */
769 /* could be recreated between the time the collector */
770 /* decides to reclaim the object and the link is */
773 GC_API int GC_unregister_disappearing_link (void * * link);
774 /* Returns 0 if link was not actually registered. */
775 /* Undoes a registration by either of the above two */
778 GC_API void GC_finalize_all();
780 /* Returns !=0 if GC_invoke_finalizers has something to do. */
781 GC_API int GC_should_invoke_finalizers(void);
783 GC_API int GC_invoke_finalizers(void);
784 /* Run finalizers for all objects that are ready to */
785 /* be finalized. Return the number of finalizers */
786 /* that were run. Normally this is also called */
787 /* implicitly during some allocations. If */
788 /* GC-finalize_on_demand is nonzero, it must be called */
791 /* Explicitly tell the collector that an object is reachable */
792 /* at a particular program point. This prevents the argument */
793 /* pointer from being optimized away, even it is otherwise no */
794 /* longer needed. It should have no visible effect in the */
795 /* absence of finalizers or disappearing links. But it may be */
796 /* needed to prevent finalizers from running while the */
797 /* associated external resource is still in use. */
798 /* The function is sometimes called keep_alive in other */
800 # if defined(__GNUC__) && !defined(__INTEL_COMPILER)
801 # define GC_reachable_here(ptr) \
802 __asm__ volatile(" " : : "X"(ptr) : "memory");
804 GC_API void GC_noop1(GC_word x);
805 # define GC_reachable_here(ptr) GC_noop1((GC_word)(ptr));
808 /* GC_set_warn_proc can be used to redirect or filter warning messages. */
809 /* p may not be a NULL pointer. */
810 typedef void (*GC_warn_proc) (char *msg, GC_word arg);
811 GC_API GC_warn_proc GC_set_warn_proc(GC_warn_proc p);
812 /* Returns old warning procedure. */
814 GC_API GC_word GC_set_free_space_divisor(GC_word value);
815 /* Set free_space_divisor. See above for definition. */
816 /* Returns old value. */
818 /* The following is intended to be used by a higher level */
819 /* (e.g. Java-like) finalization facility. It is expected */
820 /* that finalization code will arrange for hidden pointers to */
821 /* disappear. Otherwise objects can be accessed after they */
822 /* have been collected. */
823 /* Note that putting pointers in atomic objects or in */
824 /* nonpointer slots of "typed" objects is equivalent to */
825 /* disguising them in this way, and may have other advantages. */
826 # if defined(I_HIDE_POINTERS) || defined(GC_I_HIDE_POINTERS)
827 typedef GC_word GC_hidden_pointer;
828 # define HIDE_POINTER(p) (~(GC_hidden_pointer)(p))
829 # define REVEAL_POINTER(p) ((void *)(HIDE_POINTER(p)))
830 /* Converting a hidden pointer to a real pointer requires verifying */
831 /* that the object still exists. This involves acquiring the */
832 /* allocator lock to avoid a race with the collector. */
833 # endif /* I_HIDE_POINTERS */
835 typedef void * (*GC_fn_type) (void * client_data);
836 GC_API void * GC_call_with_alloc_lock (GC_fn_type fn, void * client_data);
838 /* These routines are intended to explicitly notify the collector */
839 /* of new threads. Often this is unnecessary because thread creation */
840 /* is implicitly intercepted by the collector, using header-file */
841 /* defines, or linker-based interception. In the long run the intent */
842 /* is to always make redundant registration safe. In the short run, */
843 /* this is being implemented a platform at a time. */
844 /* The interface is complicated by the fact that we probably will not */
845 /* ever be able to automatically determine the stack base for thread */
846 /* stacks on all platforms. */
848 /* Structure representing the base of a thread stack. On most */
849 /* platforms this contains just a single address. */
850 struct GC_stack_base {
851 void * mem_base; /* Base of memory stack. */
852 # if defined(__ia64) || defined(__ia64__)
853 void * reg_base; /* Base of separate register stack. */
857 typedef void * (*GC_stack_base_func)(struct GC_stack_base *sb, void *arg);
859 /* Call a function with a stack base structure corresponding to */
860 /* somewhere in the GC_call_with_stack_base frame. This often can */
861 /* be used to provide a sufficiently accurate stack base. And we */
862 /* implement it everywhere. */
863 GC_API void * GC_call_with_stack_base(GC_stack_base_func fn, void *arg);
865 /* Register the current thread, with the indicated stack base, as */
866 /* a new thread whose stack(s) should be traced by the GC. If a */
867 /* platform does not implicitly do so, this must be called before a */
868 /* thread can allocate garbage collected memory, or assign pointers */
869 /* to the garbage collected heap. Once registered, a thread will be */
870 /* stopped during garbage collections. */
873 #define GC_DUPLICATE 1 /* Was already registered. */
874 #define GC_NO_THREADS 2 /* No thread support in GC. */
875 #define GC_UNIMPLEMENTED 3 /* Not yet implemented on this platform. */
876 GC_API int GC_register_my_thread(struct GC_stack_base *);
878 /* Unregister the current thread. The thread may no longer allocate */
879 /* garbage collected memory or manipulate pointers to the */
880 /* garbage collected heap after making this call. */
881 /* Specifically, if it wants to return or otherwise communicate a */
882 /* pointer to the garbage-collected heap to another thread, it must */
883 /* do this before calling GC_unregister_my_thread, most probably */
884 /* by saving it in a global data structure. */
885 GC_API int GC_unregister_my_thread(void);
887 /* Attempt to fill in the GC_stack_base structure with the stack base */
888 /* for this thread. This appears to be required to implement anything */
889 /* like the JNI AttachCurrentThread in an environment in which new */
890 /* threads are not automatically registered with the collector. */
891 /* It is also unfortunately hard to implement well on many platforms. */
892 /* Returns GC_SUCCESS or GC_UNIMPLEMENTED. */
893 GC_API int GC_get_stack_base(struct GC_stack_base *);
895 /* The following routines are primarily intended for use with a */
896 /* preprocessor which inserts calls to check C pointer arithmetic. */
897 /* They indicate failure by invoking the corresponding _print_proc. */
899 /* Check that p and q point to the same object. */
900 /* Fail conspicuously if they don't. */
901 /* Returns the first argument. */
902 /* Succeeds if neither p nor q points to the heap. */
903 /* May succeed if both p and q point to between heap objects. */
904 GC_API void * GC_same_obj (void * p, void * q);
906 /* Checked pointer pre- and post- increment operations. Note that */
907 /* the second argument is in units of bytes, not multiples of the */
908 /* object size. This should either be invoked from a macro, or the */
909 /* call should be automatically generated. */
910 GC_API void * GC_pre_incr (void * *p, size_t how_much);
911 GC_API void * GC_post_incr (void * *p, size_t how_much);
913 /* Check that p is visible */
914 /* to the collector as a possibly pointer containing location. */
915 /* If it isn't fail conspicuously. */
916 /* Returns the argument in all cases. May erroneously succeed */
917 /* in hard cases. (This is intended for debugging use with */
918 /* untyped allocations. The idea is that it should be possible, though */
919 /* slow, to add such a call to all indirect pointer stores.) */
920 /* Currently useless for multithreaded worlds. */
921 GC_API void * GC_is_visible (void * p);
923 /* Check that if p is a pointer to a heap page, then it points to */
924 /* a valid displacement within a heap object. */
925 /* Fail conspicuously if this property does not hold. */
926 /* Uninteresting with GC_all_interior_pointers. */
927 /* Always returns its argument. */
928 GC_API void * GC_is_valid_displacement (void * p);
930 /* Explicitly dump the GC state. This is most often called from the */
931 /* debugger, or by setting the GC_DUMP_REGULARLY environment variable, */
932 /* but it may be useful to call it from client code during debugging. */
935 /* Safer, but slow, pointer addition. Probably useful mainly with */
936 /* a preprocessor. Useful only for heap pointers. */
938 # define GC_PTR_ADD3(x, n, type_of_result) \
939 ((type_of_result)GC_same_obj((x)+(n), (x)))
940 # define GC_PRE_INCR3(x, n, type_of_result) \
941 ((type_of_result)GC_pre_incr(&(x), (n)*sizeof(*x))
942 # define GC_POST_INCR2(x, type_of_result) \
943 ((type_of_result)GC_post_incr(&(x), sizeof(*x))
945 # define GC_PTR_ADD(x, n) \
946 GC_PTR_ADD3(x, n, typeof(x))
947 # define GC_PRE_INCR(x, n) \
948 GC_PRE_INCR3(x, n, typeof(x))
949 # define GC_POST_INCR(x, n) \
950 GC_POST_INCR3(x, typeof(x))
952 /* We can't do this right without typeof, which ANSI */
953 /* decided was not sufficiently useful. Repeatedly */
954 /* mentioning the arguments seems too dangerous to be */
955 /* useful. So does not casting the result. */
956 # define GC_PTR_ADD(x, n) ((x)+(n))
958 #else /* !GC_DEBUG */
959 # define GC_PTR_ADD3(x, n, type_of_result) ((x)+(n))
960 # define GC_PTR_ADD(x, n) ((x)+(n))
961 # define GC_PRE_INCR3(x, n, type_of_result) ((x) += (n))
962 # define GC_PRE_INCR(x, n) ((x) += (n))
963 # define GC_POST_INCR2(x, n, type_of_result) ((x)++)
964 # define GC_POST_INCR(x, n) ((x)++)
967 /* Safer assignment of a pointer to a nonstack location. */
969 # define GC_PTR_STORE(p, q) \
970 (*(void **)GC_is_visible(p) = GC_is_valid_displacement(q))
971 #else /* !GC_DEBUG */
972 # define GC_PTR_STORE(p, q) (*(p) = (q))
975 /* Functions called to report pointer checking errors */
976 GC_API void (*GC_same_obj_print_proc) (void * p, void * q);
978 GC_API void (*GC_is_valid_displacement_print_proc) (void * p);
980 GC_API void (*GC_is_visible_print_proc) (void * p);
983 /* For pthread support, we generally need to intercept a number of */
984 /* thread library calls. We do that here by macro defining them. */
986 #if !defined(GC_USE_LD_WRAP) && !defined(GC_NO_THREAD_REDIRECTS) \
987 && defined(GC_PTHREADS)
988 # include "gc_pthread_redirects.h"
991 # if defined(PCR) || defined(GC_SOLARIS_THREADS) || \
992 defined(GC_PTHREADS) || defined(GC_WIN32_THREADS)
993 /* Any flavor of threads. */
994 /* This returns a list of objects, linked through their first */
995 /* word. Its use can greatly reduce lock contention problems, since */
996 /* the allocation lock can be acquired and released many fewer times. */
997 /* It is used internally by gc_local_alloc.h, which provides a simpler */
998 /* programming interface on Linux. */
999 void * GC_malloc_many(size_t lb);
1000 #define GC_NEXT(p) (*(void * *)(p)) /* Retrieve the next element */
1001 /* in returned list. */
1003 #endif /* THREADS */
1005 /* Register a callback to control the scanning of dynamic libraries.
1006 When the GC scans the static data of a dynamic library, it will
1007 first call a user-supplied routine with filename of the library and
1008 the address and length of the memory region. This routine should
1009 return nonzero if that region should be scanned. */
1011 GC_register_has_static_roots_callback
1012 (int (*callback)(const char *, void *, size_t));
1015 #if defined(GC_WIN32_THREADS) && !defined(__CYGWIN32__) \
1016 && !defined(__CYGWIN__) \
1017 && !defined(GC_PTHREADS)
1020 } /* Including windows.h in an extern "C" context no longer works. */
1023 #ifndef GC_NO_THREAD_DECLS
1024 # include <windows.h>
1030 * All threads must be created using GC_CreateThread or GC_beginthreadex,
1031 * or must explicitly call GC_register_my_thread,
1032 * so that they will be recorded in the thread table.
1033 * For backwards compatibility, it is possible to build the GC
1034 * with GC_DLL defined, and to call GC_use_DllMain().
1035 * This implicitly registers all created threads, but appears to be
1038 * Currently the collector expects all threads to fall through and
1039 * terminate normally, or call GC_endthreadex() or GC_ExitThread,
1040 * so that the thread is properly unregistered. (An explicit call
1041 * to GC_unregister_my_thread() should also work, but risks unregistering
1042 * the thread twice.)
1044 GC_API HANDLE WINAPI GC_CreateThread(
1045 LPSECURITY_ATTRIBUTES lpThreadAttributes,
1046 DWORD dwStackSize, LPTHREAD_START_ROUTINE lpStartAddress,
1047 LPVOID lpParameter, DWORD dwCreationFlags, LPDWORD lpThreadId );
1049 # if defined(_MSC_VER) && _MSC_VER >= 1200 && !defined(_UINTPTR_T_DEFINED)
1050 typedef unsigned long uintptr_t;
1053 GC_API uintptr_t GC_beginthreadex(
1054 void *security, unsigned stack_size,
1055 unsigned ( __stdcall *start_address )( void * ),
1056 void *arglist, unsigned initflag, unsigned *thrdaddr);
1058 GC_API void GC_endthreadex(unsigned retval);
1060 GC_API void WINAPI GC_ExitThread(DWORD dwExitCode);
1062 # if defined(_WIN32_WCE)
1064 * win32_threads.c implements the real WinMain, which will start a new thread
1065 * to call GC_WinMain after initializing the garbage collector.
1067 GC_API int WINAPI GC_WinMain(
1068 HINSTANCE hInstance,
1069 HINSTANCE hPrevInstance,
1073 # define WinMain GC_WinMain
1075 # endif /* defined(_WIN32_WCE) */
1076 #endif /* !GC_NO_THREAD_DECLS */
1079 * Use implicit thread registration via DllMain.
1080 * Must be called before GC_INIT and other GC routines.
1081 * Should be avoided if GC_beginthreadex and friends can be called
1084 GC_API void GC_use_DllMain(void);
1086 # ifndef GC_NO_THREAD_REDIRECTS
1087 # define CreateThread GC_CreateThread
1088 # define ExitThread GC_ExitThread
1089 # define _beginthreadex GC_beginthreadex
1090 # define _endthreadex GC_endthreadex
1091 # define _beginthread { > "Please use _beginthreadex instead of _beginthread" < }
1092 # endif /* !GC_NO_THREAD_REDIRECTS */
1094 #endif /* defined(GC_WIN32_THREADS) && !cygwin */
1097 * Fully portable code should call GC_INIT() from the main program
1098 * before making any other GC_ calls. On most platforms this is a
1099 * no-op and the collector self-initializes. But a number of platforms
1100 * make that too hard.
1101 * A GC_INIT call is required if the collector is built with THREAD_LOCAL_ALLOC
1102 * defined and the initial allocation call is not to GC_malloc() or
1103 * GC_malloc_atomic().
1105 #if defined(__CYGWIN32__) || defined (_AIX)
1107 * Similarly gnu-win32 DLLs need explicit initialization from
1108 * the main program, as does AIX.
1110 # ifdef __CYGWIN32__
1111 extern int _data_start__[];
1112 extern int _data_end__[];
1113 extern int _bss_start__[];
1114 extern int _bss_end__[];
1115 # define GC_MAX(x,y) ((x) > (y) ? (x) : (y))
1116 # define GC_MIN(x,y) ((x) < (y) ? (x) : (y))
1117 # define GC_DATASTART ((void *) GC_MIN(_data_start__, _bss_start__))
1118 # define GC_DATAEND ((void *) GC_MAX(_data_end__, _bss_end__))
1119 # define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); \
1120 GC_gcollect(); /* For blacklisting. */}
1121 /* Required at least if GC is in dll. And doesn't hurt. */
1124 extern int _data[], _end[];
1125 # define GC_DATASTART ((void *)((ulong)_data))
1126 # define GC_DATAEND ((void *)((ulong)_end))
1127 # define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); }
1130 # define GC_INIT() { GC_init(); }
1133 #if !defined(_WIN32_WCE) \
1134 && ((defined(_MSDOS) || defined(_MSC_VER)) && (_M_IX86 >= 300) \
1135 || defined(_WIN32) && !defined(__CYGWIN32__) && !defined(__CYGWIN__))
1136 /* win32S may not free all resources on process exit. */
1137 /* This explicitly deallocates the heap. */
1138 GC_API void GC_win32_free_heap ();
1141 #if ( defined(_AMIGA) && !defined(GC_AMIGA_MAKINGLIB) )
1142 /* Allocation really goes through GC_amiga_allocwrapper_do */
1143 # include "gc_amiga_redirects.h"
1146 #if defined(GC_REDIRECT_TO_LOCAL)
1147 /* Now redundant; that's the default with THREAD_LOCAL_ALLOC */
1151 } /* end of extern "C" */
projects / cacao.git / blob