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);
245 /* Added for cacao */
251 * general purpose allocation routines, with roughly malloc calling conv.
252 * The atomic versions promise that no relevant pointers are contained
253 * in the object. The nonatomic versions guarantee that the new object
254 * is cleared. GC_malloc_stubborn promises that no changes to the object
255 * will occur after GC_end_stubborn_change has been called on the
256 * result of GC_malloc_stubborn. GC_malloc_uncollectable allocates an object
257 * that is scanned for pointers to collectable objects, but is not itself
258 * collectable. The object is scanned even if it does not appear to
259 * be reachable. GC_malloc_uncollectable and GC_free called on the resulting
260 * object implicitly update GC_non_gc_bytes appropriately.
262 * Note that the GC_malloc_stubborn support is stubbed out by default
263 * starting in 6.0. GC_malloc_stubborn is an alias for GC_malloc unless
264 * the collector is built with STUBBORN_ALLOC defined.
266 GC_API void * GC_malloc(size_t size_in_bytes);
267 GC_API void * GC_malloc_atomic(size_t size_in_bytes);
268 GC_API char * GC_strdup (const char *str);
269 GC_API void * GC_malloc_uncollectable(size_t size_in_bytes);
270 GC_API void * GC_malloc_stubborn(size_t size_in_bytes);
272 /* The following is only defined if the library has been suitably */
274 GC_API void * GC_malloc_atomic_uncollectable(size_t size_in_bytes);
276 /* Explicitly deallocate an object. Dangerous if used incorrectly. */
277 /* Requires a pointer to the base of an object. */
278 /* If the argument is stubborn, it should not be changeable when freed. */
279 /* An object should not be enable for finalization when it is */
280 /* explicitly deallocated. */
281 /* GC_free(0) is a no-op, as required by ANSI C for free. */
282 GC_API void GC_free(void * object_addr);
285 * Stubborn objects may be changed only if the collector is explicitly informed.
286 * The collector is implicitly informed of coming change when such
287 * an object is first allocated. The following routines inform the
288 * collector that an object will no longer be changed, or that it will
289 * once again be changed. Only nonNIL pointer stores into the object
290 * are considered to be changes. The argument to GC_end_stubborn_change
291 * must be exacly the value returned by GC_malloc_stubborn or passed to
292 * GC_change_stubborn. (In the second case it may be an interior pointer
293 * within 512 bytes of the beginning of the objects.)
294 * There is a performance penalty for allowing more than
295 * one stubborn object to be changed at once, but it is acceptable to
296 * do so. The same applies to dropping stubborn objects that are still
299 GC_API void GC_change_stubborn(void *);
300 GC_API void GC_end_stubborn_change(void *);
302 /* Return a pointer to the base (lowest address) of an object given */
303 /* a pointer to a location within the object. */
304 /* I.e. map an interior pointer to the corresponding bas pointer. */
305 /* Note that with debugging allocation, this returns a pointer to the */
306 /* actual base of the object, i.e. the debug information, not to */
307 /* the base of the user object. */
308 /* Return 0 if displaced_pointer doesn't point to within a valid */
310 /* Note that a deallocated object in the garbage collected heap */
311 /* may be considered valid, even if it has been deallocated with */
313 GC_API void * GC_base(void * displaced_pointer);
315 /* Given a pointer to the base of an object, return its size in bytes. */
316 /* The returned size may be slightly larger than what was originally */
318 GC_API size_t GC_size(void * object_addr);
320 /* For compatibility with C library. This is occasionally faster than */
321 /* a malloc followed by a bcopy. But if you rely on that, either here */
322 /* or with the standard C library, your code is broken. In my */
323 /* opinion, it shouldn't have been invented, but now we're stuck. -HB */
324 /* The resulting object has the same kind as the original. */
325 /* If the argument is stubborn, the result will have changes enabled. */
326 /* It is an error to have changes enabled for the original object. */
327 /* Follows ANSI comventions for NULL old_object. */
328 GC_API void * GC_realloc(void * old_object, size_t new_size_in_bytes);
330 /* Explicitly increase the heap size. */
331 /* Returns 0 on failure, 1 on success. */
332 GC_API int GC_expand_hp(size_t number_of_bytes);
334 /* Limit the heap size to n bytes. Useful when you're debugging, */
335 /* especially on systems that don't handle running out of memory well. */
336 /* n == 0 ==> unbounded. This is the default. */
337 GC_API void GC_set_max_heap_size(GC_word n);
339 GC_API GC_word GC_get_max_heap_size(void);
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(void * low_address,
347 void * high_address_plus_1);
349 /* Clear the set of root segments. Wizards only. */
350 GC_API void GC_clear_roots(void);
352 /* Add a root segment. Wizards only. */
353 GC_API void GC_add_roots(void * low_address, void * high_address_plus_1);
355 /* Remove a root segment. Wizards only. */
356 GC_API void GC_remove_roots(void * low_address, void * high_address_plus_1);
358 /* Add a displacement to the set of those considered valid by the */
359 /* collector. GC_register_displacement(n) means that if p was returned */
360 /* by GC_malloc, then (char *)p + n will be considered to be a valid */
361 /* pointer to p. N must be small and less than the size of p. */
362 /* (All pointers to the interior of objects from the stack are */
363 /* considered valid in any case. This applies to heap objects and */
365 /* Preferably, this should be called before any other GC procedures. */
366 /* Calling it later adds to the probability of excess memory */
368 /* This is a no-op if the collector has recognition of */
369 /* arbitrary interior pointers enabled, which is now the default. */
370 GC_API void GC_register_displacement(size_t n);
372 /* The following version should be used if any debugging allocation is */
374 GC_API void GC_debug_register_displacement(size_t n);
376 /* Explicitly trigger a full, world-stop collection. */
377 GC_API void GC_gcollect(void);
379 /* Trigger a full world-stopped collection. Abort the collection if */
380 /* and when stop_func returns a nonzero value. Stop_func will be */
381 /* called frequently, and should be reasonably fast. This works even */
382 /* if virtual dirty bits, and hence incremental collection is not */
383 /* available for this architecture. Collections can be aborted faster */
384 /* than normal pause times for incremental collection. However, */
385 /* aborted collections do no useful work; the next collection needs */
386 /* to start from the beginning. */
387 /* Return 0 if the collection was aborted, 1 if it succeeded. */
388 typedef int (* GC_stop_func)(void);
389 GC_API int GC_try_to_collect(GC_stop_func stop_func);
391 /* Return the number of bytes in the heap. Excludes collector private */
392 /* data structures. Includes empty blocks and fragmentation loss. */
393 /* Includes some pages that were allocated but never written. */
394 GC_API size_t GC_get_heap_size(void);
396 /* Return a lower bound on the number of free bytes in the heap. */
397 GC_API size_t GC_get_free_bytes(void);
399 /* Return the number of bytes allocated since the last collection. */
400 GC_API size_t GC_get_bytes_since_gc(void);
402 /* Return the total number of bytes allocated in this process. */
403 /* Never decreases, except due to wrapping. */
404 GC_API size_t GC_get_total_bytes(void);
406 /* Disable garbage collection. Even GC_gcollect calls will be */
408 GC_API void GC_disable(void);
410 /* Reenable garbage collection. GC_disable() and GC_enable() calls */
411 /* nest. Garbage collection is enabled if the number of calls to both */
412 /* both functions is equal. */
413 GC_API void GC_enable(void);
415 /* Enable incremental/generational collection. */
416 /* Not advisable unless dirty bits are */
417 /* available or most heap objects are */
418 /* pointerfree(atomic) or immutable. */
419 /* Don't use in leak finding mode. */
420 /* Ignored if GC_dont_gc is true. */
421 /* Only the generational piece of this is */
422 /* functional if GC_parallel is TRUE */
423 /* or if GC_time_limit is GC_TIME_UNLIMITED. */
424 /* Causes GC_local_gcj_malloc() to revert to */
425 /* locked allocation. Must be called */
426 /* before any GC_local_gcj_malloc() calls. */
427 /* For best performance, should be called as early as possible. */
428 /* On some platforms, calling it later may have adverse effects.*/
429 /* Safe to call before GC_INIT(). Includes a GC_init() call. */
430 GC_API void GC_enable_incremental(void);
432 /* Does incremental mode write-protect pages? Returns zero or */
433 /* more of the following, or'ed together: */
434 #define GC_PROTECTS_POINTER_HEAP 1 /* May protect non-atomic objs. */
435 #define GC_PROTECTS_PTRFREE_HEAP 2
436 #define GC_PROTECTS_STATIC_DATA 4 /* Currently never. */
437 #define GC_PROTECTS_STACK 8 /* Probably impractical. */
439 #define GC_PROTECTS_NONE 0
440 GC_API int GC_incremental_protection_needs(void);
442 /* Perform some garbage collection work, if appropriate. */
443 /* Return 0 if there is no more work to be done. */
444 /* Typically performs an amount of work corresponding roughly */
445 /* to marking from one page. May do more work if further */
446 /* progress requires it, e.g. if incremental collection is */
447 /* disabled. It is reasonable to call this in a wait loop */
448 /* until it returns 0. */
449 GC_API int GC_collect_a_little(void);
451 /* Allocate an object of size lb bytes. The client guarantees that */
452 /* as long as the object is live, it will be referenced by a pointer */
453 /* that points to somewhere within the first 256 bytes of the object. */
454 /* (This should normally be declared volatile to prevent the compiler */
455 /* from invalidating this assertion.) This routine is only useful */
456 /* if a large array is being allocated. It reduces the chance of */
457 /* accidentally retaining such an array as a result of scanning an */
458 /* integer that happens to be an address inside the array. (Actually, */
459 /* it reduces the chance of the allocator not finding space for such */
460 /* an array, since it will try hard to avoid introducing such a false */
461 /* reference.) On a SunOS 4.X or MS Windows system this is recommended */
462 /* for arrays likely to be larger than 100K or so. For other systems, */
463 /* or if the collector is not configured to recognize all interior */
464 /* pointers, the threshold is normally much higher. */
465 GC_API void * GC_malloc_ignore_off_page(size_t lb);
466 GC_API void * GC_malloc_atomic_ignore_off_page(size_t lb);
468 #if defined(__sgi) && !defined(__GNUC__) && _COMPILER_VERSION >= 720
469 # define GC_ADD_CALLER
470 # define GC_RETURN_ADDR (GC_word)__return_address
473 #if defined(__linux__) || defined(__GLIBC__)
474 # include <features.h>
475 # if (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 1 || __GLIBC__ > 2) \
476 && !defined(__ia64__) && !defined(__UCLIBC__)
477 # ifndef GC_HAVE_BUILTIN_BACKTRACE
478 /* # define GC_HAVE_BUILTIN_BACKTRACE */
481 # if defined(__i386__) || defined(__x86_64__)
482 # define GC_CAN_SAVE_CALL_STACKS
486 #if defined(_MSC_VER) && _MSC_VER >= 1200 /* version 12.0+ (MSVC 6.0+) */ \
488 # ifndef GC_HAVE_NO_BUILTIN_BACKTRACE
489 # define GC_HAVE_BUILTIN_BACKTRACE
493 #if defined(GC_HAVE_BUILTIN_BACKTRACE) && !defined(GC_CAN_SAVE_CALL_STACKS)
494 # define GC_CAN_SAVE_CALL_STACKS
497 #if defined(__sparc__)
498 # define GC_CAN_SAVE_CALL_STACKS
501 /* If we're on an a platform on which we can't save call stacks, but */
502 /* gcc is normally used, we go ahead and define GC_ADD_CALLER. */
503 /* We make this decision independent of whether gcc is actually being */
504 /* used, in order to keep the interface consistent, and allow mixing */
506 /* This may also be desirable if it is possible but expensive to */
507 /* retrieve the call chain. */
508 #if (defined(__linux__) || defined(__NetBSD__) || defined(__OpenBSD__) \
509 || defined(__FreeBSD__) || defined(__DragonFly__)) & !defined(GC_CAN_SAVE_CALL_STACKS)
510 # define GC_ADD_CALLER
511 # if __GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)
512 /* gcc knows how to retrieve return address, but we don't know */
513 /* how to generate call stacks. */
514 # define GC_RETURN_ADDR (GC_word)__builtin_return_address(0)
516 /* Just pass 0 for gcc compatibility. */
517 # define GC_RETURN_ADDR 0
522 # define GC_EXTRAS GC_RETURN_ADDR, __FILE__, __LINE__
523 # define GC_EXTRA_PARAMS GC_word ra, const char * s, int i
525 # define GC_EXTRAS __FILE__, __LINE__
526 # define GC_EXTRA_PARAMS const char * s, int i
529 /* Debugging (annotated) allocation. GC_gcollect will check */
530 /* objects allocated in this way for overwrites, etc. */
531 GC_API void * GC_debug_malloc(size_t size_in_bytes, GC_EXTRA_PARAMS);
532 GC_API void * GC_debug_malloc_atomic(size_t size_in_bytes, GC_EXTRA_PARAMS);
533 GC_API char * GC_debug_strdup(const char *str, GC_EXTRA_PARAMS);
534 GC_API void * GC_debug_malloc_uncollectable
535 (size_t size_in_bytes, GC_EXTRA_PARAMS);
536 GC_API void * GC_debug_malloc_stubborn
537 (size_t size_in_bytes, GC_EXTRA_PARAMS);
538 GC_API void * GC_debug_malloc_ignore_off_page
539 (size_t size_in_bytes, GC_EXTRA_PARAMS);
540 GC_API void * GC_debug_malloc_atomic_ignore_off_page
541 (size_t size_in_bytes, GC_EXTRA_PARAMS);
542 GC_API void GC_debug_free (void * object_addr);
543 GC_API void * GC_debug_realloc
544 (void * old_object, size_t new_size_in_bytes, GC_EXTRA_PARAMS);
545 GC_API void GC_debug_change_stubborn(void *);
546 GC_API void GC_debug_end_stubborn_change(void *);
548 /* Routines that allocate objects with debug information (like the */
549 /* above), but just fill in dummy file and line number information. */
550 /* Thus they can serve as drop-in malloc/realloc replacements. This */
551 /* can be useful for two reasons: */
552 /* 1) It allows the collector to be built with DBG_HDRS_ALL defined */
553 /* even if some allocation calls come from 3rd party libraries */
554 /* that can't be recompiled. */
555 /* 2) On some platforms, the file and line information is redundant, */
556 /* since it can be reconstructed from a stack trace. On such */
557 /* platforms it may be more convenient not to recompile, e.g. for */
558 /* leak detection. This can be accomplished by instructing the */
559 /* linker to replace malloc/realloc with these. */
560 GC_API void * GC_debug_malloc_replacement (size_t size_in_bytes);
561 GC_API void * GC_debug_realloc_replacement
562 (void * object_addr, size_t size_in_bytes);
565 # define GC_MALLOC(sz) GC_debug_malloc(sz, GC_EXTRAS)
566 # define GC_MALLOC_ATOMIC(sz) GC_debug_malloc_atomic(sz, GC_EXTRAS)
567 # define GC_STRDUP(s) GC_debug_strdup((s), GC_EXTRAS)
568 # define GC_MALLOC_UNCOLLECTABLE(sz) \
569 GC_debug_malloc_uncollectable(sz, GC_EXTRAS)
570 # define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
571 GC_debug_malloc_ignore_off_page(sz, GC_EXTRAS)
572 # define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
573 GC_debug_malloc_atomic_ignore_off_page(sz, GC_EXTRAS)
574 # define GC_REALLOC(old, sz) GC_debug_realloc(old, sz, GC_EXTRAS)
575 # define GC_FREE(p) GC_debug_free(p)
576 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
577 GC_debug_register_finalizer(p, f, d, of, od)
578 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
579 GC_debug_register_finalizer_ignore_self(p, f, d, of, od)
580 # define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
581 GC_debug_register_finalizer_no_order(p, f, d, of, od)
582 # define GC_REGISTER_FINALIZER_UNREACHABLE(p, f, d, of, od) \
583 GC_debug_register_finalizer_unreachable(p, f, d, of, od)
584 # define GC_MALLOC_STUBBORN(sz) GC_debug_malloc_stubborn(sz, GC_EXTRAS);
585 # define GC_CHANGE_STUBBORN(p) GC_debug_change_stubborn(p)
586 # define GC_END_STUBBORN_CHANGE(p) GC_debug_end_stubborn_change(p)
587 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
588 GC_general_register_disappearing_link(link, GC_base(obj))
589 # define GC_REGISTER_DISPLACEMENT(n) GC_debug_register_displacement(n)
591 # define GC_MALLOC(sz) GC_malloc(sz)
592 # define GC_MALLOC_ATOMIC(sz) GC_malloc_atomic(sz)
593 # define GC_STRDUP(s) GC_strdup(s)
594 # define GC_MALLOC_UNCOLLECTABLE(sz) GC_malloc_uncollectable(sz)
595 # define GC_MALLOC_IGNORE_OFF_PAGE(sz) \
596 GC_malloc_ignore_off_page(sz)
597 # define GC_MALLOC_ATOMIC_IGNORE_OFF_PAGE(sz) \
598 GC_malloc_atomic_ignore_off_page(sz)
599 # define GC_REALLOC(old, sz) GC_realloc(old, sz)
600 # define GC_FREE(p) GC_free(p)
601 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
602 GC_register_finalizer(p, f, d, of, od)
603 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
604 GC_register_finalizer_ignore_self(p, f, d, of, od)
605 # define GC_REGISTER_FINALIZER_NO_ORDER(p, f, d, of, od) \
606 GC_register_finalizer_no_order(p, f, d, of, od)
607 # define GC_REGISTER_FINALIZER_UNREACHABLE(p, f, d, of, od) \
608 GC_register_finalizer_unreachable(p, f, d, of, od)
609 # define GC_MALLOC_STUBBORN(sz) GC_malloc_stubborn(sz)
610 # define GC_CHANGE_STUBBORN(p) GC_change_stubborn(p)
611 # define GC_END_STUBBORN_CHANGE(p) GC_end_stubborn_change(p)
612 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
613 GC_general_register_disappearing_link(link, obj)
614 # define GC_REGISTER_DISPLACEMENT(n) GC_register_displacement(n)
616 /* The following are included because they are often convenient, and */
617 /* reduce the chance for a misspecifed size argument. But calls may */
618 /* expand to something syntactically incorrect if t is a complicated */
619 /* type expression. */
620 # define GC_NEW(t) (t *)GC_MALLOC(sizeof (t))
621 # define GC_NEW_ATOMIC(t) (t *)GC_MALLOC_ATOMIC(sizeof (t))
622 # define GC_NEW_STUBBORN(t) (t *)GC_MALLOC_STUBBORN(sizeof (t))
623 # define GC_NEW_UNCOLLECTABLE(t) (t *)GC_MALLOC_UNCOLLECTABLE(sizeof (t))
625 /* Finalization. Some of these primitives are grossly unsafe. */
626 /* The idea is to make them both cheap, and sufficient to build */
627 /* a safer layer, closer to Modula-3, Java, or PCedar finalization. */
628 /* The interface represents my conclusions from a long discussion */
629 /* with Alan Demers, Dan Greene, Carl Hauser, Barry Hayes, */
630 /* Christian Jacobi, and Russ Atkinson. It's not perfect, and */
631 /* probably nobody else agrees with it. Hans-J. Boehm 3/13/92 */
632 typedef void (*GC_finalization_proc) (void * obj, void * client_data);
634 GC_API void GC_register_finalizer(void * obj, GC_finalization_proc fn,
635 void * cd, GC_finalization_proc *ofn,
637 GC_API void GC_debug_register_finalizer
638 (void * obj, GC_finalization_proc fn, void * cd,
639 GC_finalization_proc *ofn, void * *ocd);
640 /* When obj is no longer accessible, invoke */
641 /* (*fn)(obj, cd). If a and b are inaccessible, and */
642 /* a points to b (after disappearing links have been */
643 /* made to disappear), then only a will be */
644 /* finalized. (If this does not create any new */
645 /* pointers to b, then b will be finalized after the */
646 /* next collection.) Any finalizable object that */
647 /* is reachable from itself by following one or more */
648 /* pointers will not be finalized (or collected). */
649 /* Thus cycles involving finalizable objects should */
650 /* be avoided, or broken by disappearing links. */
651 /* All but the last finalizer registered for an object */
653 /* Finalization may be removed by passing 0 as fn. */
654 /* Finalizers are implicitly unregistered just before */
655 /* they are invoked. */
656 /* The old finalizer and client data are stored in */
658 /* Fn is never invoked on an accessible object, */
659 /* provided hidden pointers are converted to real */
660 /* pointers only if the allocation lock is held, and */
661 /* such conversions are not performed by finalization */
663 /* If GC_register_finalizer is aborted as a result of */
664 /* a signal, the object may be left with no */
665 /* finalization, even if neither the old nor new */
666 /* finalizer were NULL. */
667 /* Obj should be the nonNULL starting address of an */
668 /* object allocated by GC_malloc or friends. */
669 /* Note that any garbage collectable object referenced */
670 /* by cd will be considered accessible until the */
671 /* finalizer is invoked. */
673 /* Another versions of the above follow. It ignores */
674 /* self-cycles, i.e. pointers from a finalizable object to */
675 /* itself. There is a stylistic argument that this is wrong, */
676 /* but it's unavoidable for C++, since the compiler may */
677 /* silently introduce these. It's also benign in that specific */
678 /* case. And it helps if finalizable objects are split to */
680 /* Note that cd will still be viewed as accessible, even if it */
681 /* refers to the object itself. */
682 GC_API void GC_register_finalizer_ignore_self
683 (void * obj, GC_finalization_proc fn, void * cd,
684 GC_finalization_proc *ofn, void * *ocd);
685 GC_API void GC_debug_register_finalizer_ignore_self
686 (void * obj, GC_finalization_proc fn, void * cd,
687 GC_finalization_proc *ofn, void * *ocd);
689 /* Another version of the above. It ignores all cycles. */
690 /* It should probably only be used by Java implementations. */
691 /* Note that cd will still be viewed as accessible, even if it */
692 /* refers to the object itself. */
693 GC_API void GC_register_finalizer_no_order
694 (void * obj, GC_finalization_proc fn, void * cd,
695 GC_finalization_proc *ofn, void * *ocd);
696 GC_API void GC_debug_register_finalizer_no_order
697 (void * obj, GC_finalization_proc fn, void * cd,
698 GC_finalization_proc *ofn, void * *ocd);
700 /* This is a special finalizer that is useful when an object's */
701 /* finalizer must be run when the object is known to be no */
702 /* longer reachable, not even from other finalizable objects. */
703 /* It behaves like "normal" finalization, except that the */
704 /* finalizer is not run while the object is reachable from */
705 /* other objects specifying unordered finalization. */
706 /* Effectively it allows an object referenced, possibly */
707 /* indirectly, from an unordered finalizable object to override */
708 /* the unordered finalization request. */
709 /* This can be used in combination with finalizer_no_order so */
710 /* as to release resources that must not be released while an */
711 /* object can still be brought back to life by other */
713 /* Only works if GC_java_finalization is set. Probably only */
714 /* of interest when implementing a language that requires */
715 /* unordered finalization (e.g. Java, C#). */
716 GC_API void GC_register_finalizer_unreachable
717 (void * obj, GC_finalization_proc fn, void * cd,
718 GC_finalization_proc *ofn, void * *ocd);
719 GC_API void GC_debug_register_finalizer_unreachable
720 (void * obj, GC_finalization_proc fn, void * cd,
721 GC_finalization_proc *ofn, void * *ocd);
723 /* The following routine may be used to break cycles between */
724 /* finalizable objects, thus causing cyclic finalizable */
725 /* objects to be finalized in the correct order. Standard */
726 /* use involves calling GC_register_disappearing_link(&p), */
727 /* where p is a pointer that is not followed by finalization */
728 /* code, and should not be considered in determining */
729 /* finalization order. */
730 GC_API int GC_register_disappearing_link(void * * link );
731 /* Link should point to a field of a heap allocated */
732 /* object obj. *link will be cleared when obj is */
733 /* found to be inaccessible. This happens BEFORE any */
734 /* finalization code is invoked, and BEFORE any */
735 /* decisions about finalization order are made. */
736 /* This is useful in telling the finalizer that */
737 /* some pointers are not essential for proper */
738 /* finalization. This may avoid finalization cycles. */
739 /* Note that obj may be resurrected by another */
740 /* finalizer, and thus the clearing of *link may */
741 /* be visible to non-finalization code. */
742 /* There's an argument that an arbitrary action should */
743 /* be allowed here, instead of just clearing a pointer. */
744 /* But this causes problems if that action alters, or */
745 /* examines connectivity. */
746 /* Returns 1 if link was already registered, 0 if */
747 /* registration succeeded, 2 if it failed for lack of */
748 /* memory, and GC_oom_fn did not handle the problem. */
749 /* Only exists for backward compatibility. See below: */
751 GC_API int GC_general_register_disappearing_link (void * * link, void * obj);
752 /* A slight generalization of the above. *link is */
753 /* cleared when obj first becomes inaccessible. This */
754 /* can be used to implement weak pointers easily and */
755 /* safely. Typically link will point to a location */
756 /* holding a disguised pointer to obj. (A pointer */
757 /* inside an "atomic" object is effectively */
758 /* disguised.) In this way soft */
759 /* pointers are broken before any object */
760 /* reachable from them are finalized. Each link */
761 /* May be registered only once, i.e. with one obj */
762 /* value. This was added after a long email discussion */
763 /* with John Ellis. */
764 /* Obj must be a pointer to the first word of an object */
765 /* we allocated. It is unsafe to explicitly deallocate */
766 /* the object containing link. Explicitly deallocating */
767 /* obj may or may not cause link to eventually be */
769 /* This can be used to implement certain types of */
770 /* weak pointers. Note however that this generally */
771 /* requires that thje allocation lock is held (see */
772 /* GC_call_with_allock_lock() below) when the disguised */
773 /* pointer is accessed. Otherwise a strong pointer */
774 /* could be recreated between the time the collector */
775 /* decides to reclaim the object and the link is */
778 GC_API int GC_unregister_disappearing_link (void * * link);
779 /* Returns 0 if link was not actually registered. */
780 /* Undoes a registration by either of the above two */
783 GC_API void GC_finalize_all();
785 /* Returns !=0 if GC_invoke_finalizers has something to do. */
786 GC_API int GC_should_invoke_finalizers(void);
788 GC_API int GC_invoke_finalizers(void);
789 /* Run finalizers for all objects that are ready to */
790 /* be finalized. Return the number of finalizers */
791 /* that were run. Normally this is also called */
792 /* implicitly during some allocations. If */
793 /* GC-finalize_on_demand is nonzero, it must be called */
796 /* Explicitly tell the collector that an object is reachable */
797 /* at a particular program point. This prevents the argument */
798 /* pointer from being optimized away, even it is otherwise no */
799 /* longer needed. It should have no visible effect in the */
800 /* absence of finalizers or disappearing links. But it may be */
801 /* needed to prevent finalizers from running while the */
802 /* associated external resource is still in use. */
803 /* The function is sometimes called keep_alive in other */
805 # if defined(__GNUC__) && !defined(__INTEL_COMPILER)
806 # define GC_reachable_here(ptr) \
807 __asm__ volatile(" " : : "X"(ptr) : "memory");
809 GC_API void GC_noop1(GC_word x);
810 # define GC_reachable_here(ptr) GC_noop1((GC_word)(ptr));
813 /* GC_set_warn_proc can be used to redirect or filter warning messages. */
814 /* p may not be a NULL pointer. */
815 typedef void (*GC_warn_proc) (char *msg, GC_word arg);
816 GC_API GC_warn_proc GC_set_warn_proc(GC_warn_proc p);
817 /* Returns old warning procedure. */
819 GC_API GC_word GC_set_free_space_divisor(GC_word value);
820 /* Set free_space_divisor. See above for definition. */
821 /* Returns old value. */
823 /* The following is intended to be used by a higher level */
824 /* (e.g. Java-like) finalization facility. It is expected */
825 /* that finalization code will arrange for hidden pointers to */
826 /* disappear. Otherwise objects can be accessed after they */
827 /* have been collected. */
828 /* Note that putting pointers in atomic objects or in */
829 /* nonpointer slots of "typed" objects is equivalent to */
830 /* disguising them in this way, and may have other advantages. */
831 # if defined(I_HIDE_POINTERS) || defined(GC_I_HIDE_POINTERS)
832 typedef GC_word GC_hidden_pointer;
833 # define HIDE_POINTER(p) (~(GC_hidden_pointer)(p))
834 # define REVEAL_POINTER(p) ((void *)(HIDE_POINTER(p)))
835 /* Converting a hidden pointer to a real pointer requires verifying */
836 /* that the object still exists. This involves acquiring the */
837 /* allocator lock to avoid a race with the collector. */
838 # endif /* I_HIDE_POINTERS */
840 typedef void * (*GC_fn_type) (void * client_data);
841 GC_API void * GC_call_with_alloc_lock (GC_fn_type fn, void * client_data);
843 /* These routines are intended to explicitly notify the collector */
844 /* of new threads. Often this is unnecessary because thread creation */
845 /* is implicitly intercepted by the collector, using header-file */
846 /* defines, or linker-based interception. In the long run the intent */
847 /* is to always make redundant registration safe. In the short run, */
848 /* this is being implemented a platform at a time. */
849 /* The interface is complicated by the fact that we probably will not */
850 /* ever be able to automatically determine the stack base for thread */
851 /* stacks on all platforms. */
853 /* Structure representing the base of a thread stack. On most */
854 /* platforms this contains just a single address. */
855 struct GC_stack_base {
856 void * mem_base; /* Base of memory stack. */
857 # if defined(__ia64) || defined(__ia64__)
858 void * reg_base; /* Base of separate register stack. */
862 typedef void * (*GC_stack_base_func)(struct GC_stack_base *sb, void *arg);
864 /* Call a function with a stack base structure corresponding to */
865 /* somewhere in the GC_call_with_stack_base frame. This often can */
866 /* be used to provide a sufficiently accurate stack base. And we */
867 /* implement it everywhere. */
868 GC_API void * GC_call_with_stack_base(GC_stack_base_func fn, void *arg);
870 /* Register the current thread, with the indicated stack base, as */
871 /* a new thread whose stack(s) should be traced by the GC. If a */
872 /* platform does not implicitly do so, this must be called before a */
873 /* thread can allocate garbage collected memory, or assign pointers */
874 /* to the garbage collected heap. Once registered, a thread will be */
875 /* stopped during garbage collections. */
878 #define GC_DUPLICATE 1 /* Was already registered. */
879 #define GC_NO_THREADS 2 /* No thread support in GC. */
880 #define GC_UNIMPLEMENTED 3 /* Not yet implemented on this platform. */
881 GC_API int GC_register_my_thread(struct GC_stack_base *);
883 /* Unregister the current thread. The thread may no longer allocate */
884 /* garbage collected memory or manipulate pointers to the */
885 /* garbage collected heap after making this call. */
886 /* Specifically, if it wants to return or otherwise communicate a */
887 /* pointer to the garbage-collected heap to another thread, it must */
888 /* do this before calling GC_unregister_my_thread, most probably */
889 /* by saving it in a global data structure. */
890 GC_API int GC_unregister_my_thread(void);
892 /* Attempt to fill in the GC_stack_base structure with the stack base */
893 /* for this thread. This appears to be required to implement anything */
894 /* like the JNI AttachCurrentThread in an environment in which new */
895 /* threads are not automatically registered with the collector. */
896 /* It is also unfortunately hard to implement well on many platforms. */
897 /* Returns GC_SUCCESS or GC_UNIMPLEMENTED. */
898 GC_API int GC_get_stack_base(struct GC_stack_base *);
900 /* The following routines are primarily intended for use with a */
901 /* preprocessor which inserts calls to check C pointer arithmetic. */
902 /* They indicate failure by invoking the corresponding _print_proc. */
904 /* Check that p and q point to the same object. */
905 /* Fail conspicuously if they don't. */
906 /* Returns the first argument. */
907 /* Succeeds if neither p nor q points to the heap. */
908 /* May succeed if both p and q point to between heap objects. */
909 GC_API void * GC_same_obj (void * p, void * q);
911 /* Checked pointer pre- and post- increment operations. Note that */
912 /* the second argument is in units of bytes, not multiples of the */
913 /* object size. This should either be invoked from a macro, or the */
914 /* call should be automatically generated. */
915 GC_API void * GC_pre_incr (void * *p, size_t how_much);
916 GC_API void * GC_post_incr (void * *p, size_t how_much);
918 /* Check that p is visible */
919 /* to the collector as a possibly pointer containing location. */
920 /* If it isn't fail conspicuously. */
921 /* Returns the argument in all cases. May erroneously succeed */
922 /* in hard cases. (This is intended for debugging use with */
923 /* untyped allocations. The idea is that it should be possible, though */
924 /* slow, to add such a call to all indirect pointer stores.) */
925 /* Currently useless for multithreaded worlds. */
926 GC_API void * GC_is_visible (void * p);
928 /* Check that if p is a pointer to a heap page, then it points to */
929 /* a valid displacement within a heap object. */
930 /* Fail conspicuously if this property does not hold. */
931 /* Uninteresting with GC_all_interior_pointers. */
932 /* Always returns its argument. */
933 GC_API void * GC_is_valid_displacement (void * p);
935 /* Explicitly dump the GC state. This is most often called from the */
936 /* debugger, or by setting the GC_DUMP_REGULARLY environment variable, */
937 /* but it may be useful to call it from client code during debugging. */
940 /* Safer, but slow, pointer addition. Probably useful mainly with */
941 /* a preprocessor. Useful only for heap pointers. */
943 # define GC_PTR_ADD3(x, n, type_of_result) \
944 ((type_of_result)GC_same_obj((x)+(n), (x)))
945 # define GC_PRE_INCR3(x, n, type_of_result) \
946 ((type_of_result)GC_pre_incr(&(x), (n)*sizeof(*x))
947 # define GC_POST_INCR2(x, type_of_result) \
948 ((type_of_result)GC_post_incr(&(x), sizeof(*x))
950 # define GC_PTR_ADD(x, n) \
951 GC_PTR_ADD3(x, n, typeof(x))
952 # define GC_PRE_INCR(x, n) \
953 GC_PRE_INCR3(x, n, typeof(x))
954 # define GC_POST_INCR(x, n) \
955 GC_POST_INCR3(x, typeof(x))
957 /* We can't do this right without typeof, which ANSI */
958 /* decided was not sufficiently useful. Repeatedly */
959 /* mentioning the arguments seems too dangerous to be */
960 /* useful. So does not casting the result. */
961 # define GC_PTR_ADD(x, n) ((x)+(n))
963 #else /* !GC_DEBUG */
964 # define GC_PTR_ADD3(x, n, type_of_result) ((x)+(n))
965 # define GC_PTR_ADD(x, n) ((x)+(n))
966 # define GC_PRE_INCR3(x, n, type_of_result) ((x) += (n))
967 # define GC_PRE_INCR(x, n) ((x) += (n))
968 # define GC_POST_INCR2(x, n, type_of_result) ((x)++)
969 # define GC_POST_INCR(x, n) ((x)++)
972 /* Safer assignment of a pointer to a nonstack location. */
974 # define GC_PTR_STORE(p, q) \
975 (*(void **)GC_is_visible(p) = GC_is_valid_displacement(q))
976 #else /* !GC_DEBUG */
977 # define GC_PTR_STORE(p, q) (*(p) = (q))
980 /* Functions called to report pointer checking errors */
981 GC_API void (*GC_same_obj_print_proc) (void * p, void * q);
983 GC_API void (*GC_is_valid_displacement_print_proc) (void * p);
985 GC_API void (*GC_is_visible_print_proc) (void * p);
988 /* For pthread support, we generally need to intercept a number of */
989 /* thread library calls. We do that here by macro defining them. */
991 #if !defined(GC_USE_LD_WRAP) && !defined(GC_NO_THREAD_REDIRECTS) \
992 && defined(GC_PTHREADS)
993 # include "gc_pthread_redirects.h"
996 # if defined(PCR) || defined(GC_SOLARIS_THREADS) || \
997 defined(GC_PTHREADS) || defined(GC_WIN32_THREADS)
998 /* Any flavor of threads. */
999 /* This returns a list of objects, linked through their first */
1000 /* word. Its use can greatly reduce lock contention problems, since */
1001 /* the allocation lock can be acquired and released many fewer times. */
1002 /* It is used internally by gc_local_alloc.h, which provides a simpler */
1003 /* programming interface on Linux. */
1004 void * GC_malloc_many(size_t lb);
1005 #define GC_NEXT(p) (*(void * *)(p)) /* Retrieve the next element */
1006 /* in returned list. */
1008 #endif /* THREADS */
1010 /* Register a callback to control the scanning of dynamic libraries.
1011 When the GC scans the static data of a dynamic library, it will
1012 first call a user-supplied routine with filename of the library and
1013 the address and length of the memory region. This routine should
1014 return nonzero if that region should be scanned. */
1016 GC_register_has_static_roots_callback
1017 (int (*callback)(const char *, void *, size_t));
1020 #if defined(GC_WIN32_THREADS) && !defined(__CYGWIN32__) \
1021 && !defined(__CYGWIN__) \
1022 && !defined(GC_PTHREADS)
1025 } /* Including windows.h in an extern "C" context no longer works. */
1028 #ifndef GC_NO_THREAD_DECLS
1029 # include <windows.h>
1035 * All threads must be created using GC_CreateThread or GC_beginthreadex,
1036 * or must explicitly call GC_register_my_thread,
1037 * so that they will be recorded in the thread table.
1038 * For backwards compatibility, it is possible to build the GC
1039 * with GC_DLL defined, and to call GC_use_DllMain().
1040 * This implicitly registers all created threads, but appears to be
1043 * Currently the collector expects all threads to fall through and
1044 * terminate normally, or call GC_endthreadex() or GC_ExitThread,
1045 * so that the thread is properly unregistered. (An explicit call
1046 * to GC_unregister_my_thread() should also work, but risks unregistering
1047 * the thread twice.)
1049 GC_API HANDLE WINAPI GC_CreateThread(
1050 LPSECURITY_ATTRIBUTES lpThreadAttributes,
1051 DWORD dwStackSize, LPTHREAD_START_ROUTINE lpStartAddress,
1052 LPVOID lpParameter, DWORD dwCreationFlags, LPDWORD lpThreadId );
1054 # if defined(_MSC_VER) && _MSC_VER >= 1200 && !defined(_UINTPTR_T_DEFINED)
1055 typedef unsigned long uintptr_t;
1058 GC_API uintptr_t GC_beginthreadex(
1059 void *security, unsigned stack_size,
1060 unsigned ( __stdcall *start_address )( void * ),
1061 void *arglist, unsigned initflag, unsigned *thrdaddr);
1063 GC_API void GC_endthreadex(unsigned retval);
1065 GC_API void WINAPI GC_ExitThread(DWORD dwExitCode);
1067 # if defined(_WIN32_WCE)
1069 * win32_threads.c implements the real WinMain, which will start a new thread
1070 * to call GC_WinMain after initializing the garbage collector.
1072 GC_API int WINAPI GC_WinMain(
1073 HINSTANCE hInstance,
1074 HINSTANCE hPrevInstance,
1078 # define WinMain GC_WinMain
1080 # endif /* defined(_WIN32_WCE) */
1081 #endif /* !GC_NO_THREAD_DECLS */
1084 * Use implicit thread registration via DllMain.
1085 * Must be called before GC_INIT and other GC routines.
1086 * Should be avoided if GC_beginthreadex and friends can be called
1089 GC_API void GC_use_DllMain(void);
1091 # ifndef GC_NO_THREAD_REDIRECTS
1092 # define CreateThread GC_CreateThread
1093 # define ExitThread GC_ExitThread
1094 # define _beginthreadex GC_beginthreadex
1095 # define _endthreadex GC_endthreadex
1096 # define _beginthread { > "Please use _beginthreadex instead of _beginthread" < }
1097 # endif /* !GC_NO_THREAD_REDIRECTS */
1099 #endif /* defined(GC_WIN32_THREADS) && !cygwin */
1102 * Fully portable code should call GC_INIT() from the main program
1103 * before making any other GC_ calls. On most platforms this is a
1104 * no-op and the collector self-initializes. But a number of platforms
1105 * make that too hard.
1106 * A GC_INIT call is required if the collector is built with THREAD_LOCAL_ALLOC
1107 * defined and the initial allocation call is not to GC_malloc() or
1108 * GC_malloc_atomic().
1110 #if defined(__CYGWIN32__) || defined (_AIX)
1112 * Similarly gnu-win32 DLLs need explicit initialization from
1113 * the main program, as does AIX.
1115 # ifdef __CYGWIN32__
1116 extern int _data_start__[];
1117 extern int _data_end__[];
1118 extern int _bss_start__[];
1119 extern int _bss_end__[];
1120 # define GC_MAX(x,y) ((x) > (y) ? (x) : (y))
1121 # define GC_MIN(x,y) ((x) < (y) ? (x) : (y))
1122 # define GC_DATASTART ((void *) GC_MIN(_data_start__, _bss_start__))
1123 # define GC_DATAEND ((void *) GC_MAX(_data_end__, _bss_end__))
1124 # define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); \
1125 GC_gcollect(); /* For blacklisting. */}
1126 /* Required at least if GC is in dll. And doesn't hurt. */
1129 extern int _data[], _end[];
1130 # define GC_DATASTART ((void *)((ulong)_data))
1131 # define GC_DATAEND ((void *)((ulong)_end))
1132 # define GC_INIT() { GC_add_roots(GC_DATASTART, GC_DATAEND); }
1135 # define GC_INIT() { GC_init(); }
1138 #if !defined(_WIN32_WCE) \
1139 && ((defined(_MSDOS) || defined(_MSC_VER)) && (_M_IX86 >= 300) \
1140 || defined(_WIN32) && !defined(__CYGWIN32__) && !defined(__CYGWIN__))
1141 /* win32S may not free all resources on process exit. */
1142 /* This explicitly deallocates the heap. */
1143 GC_API void GC_win32_free_heap ();
1146 #if ( defined(_AMIGA) && !defined(GC_AMIGA_MAKINGLIB) )
1147 /* Allocation really goes through GC_amiga_allocwrapper_do */
1148 # include "gc_amiga_redirects.h"
1151 #if defined(GC_REDIRECT_TO_LOCAL)
1152 /* Now redundant; that's the default with THREAD_LOCAL_ALLOC */
1156 } /* end of extern "C" */
projects / cacao.git / blob