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