2 * Copyright 1988, 1989 Hans-J. Boehm, Alan J. Demers
3 * Copyright (c) 1991-1995 by Xerox Corporation. All rights reserved.
4 * Copyright 1996 by Silicon Graphics. All rights reserved.
6 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
7 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
9 * Permission is hereby granted to use or copy this program
10 * for any purpose, provided the above notices are retained on all copies.
11 * Permission to modify the code and to distribute modified code is granted,
12 * provided the above notices are retained, and a notice that the code was
13 * modified is included with the above copyright notice.
17 * Note that this defines a large number of tuning hooks, which can
18 * safely be ignored in nearly all cases. For normal use it suffices
19 * to call only GC_MALLOC and perhaps GC_REALLOC.
20 * For better performance, also look at GC_MALLOC_ATOMIC, and
21 * GC_enable_incremental. If you need an action to be performed
22 * immediately before an object is collected, look at GC_register_finalizer.
23 * If you are using Solaris threads, look at the end of this file.
24 * Everything else is best ignored unless you encounter performance
34 #if defined(__CYGWIN32__) && defined(GC_USE_DLL)
35 #include "libgc_globals.h"
38 #if defined(_MSC_VER) && defined(_DLL)
40 # define GC_API __declspec(dllexport)
42 # define GC_API __declspec(dllimport)
46 #if defined(__WATCOMC__) && defined(GC_DLL)
48 # define GC_API extern __declspec(dllexport)
50 # define GC_API extern __declspec(dllimport)
58 # if defined(__STDC__) || defined(__cplusplus) || defined(__BORLANDC__)
59 # define GC_PROTO(args) args
60 typedef void * GC_PTR;
62 # define GC_PROTO(args) ()
63 typedef char * GC_PTR;
71 /* Define word and signed_word to be unsigned and signed types of the */
72 /* size as char * or void *. There seems to be no way to do this */
73 /* even semi-portably. The following is probably no better/worse */
74 /* than almost anything else. */
75 /* The ANSI standard suggests that size_t and ptr_diff_t might be */
76 /* better choices. But those appear to have incorrect definitions */
77 /* on may systems. Notably "typedef int size_t" seems to be both */
78 /* frequent and WRONG. */
79 typedef unsigned long GC_word;
80 typedef long GC_signed_word;
82 /* Public read-only variables */
84 GC_API GC_word GC_gc_no;/* Counter incremented per collection. */
85 /* Includes empty GCs at startup. */
88 /* Public R/W variables */
90 GC_API GC_PTR (*GC_oom_fn) GC_PROTO((size_t bytes_requested));
91 /* When there is insufficient memory to satisfy */
92 /* an allocation request, we return */
93 /* (*GC_oom_fn)(). By default this just */
95 /* If it returns, it must return 0 or a valid */
96 /* pointer to a previously allocated heap */
99 GC_API int GC_find_leak;
100 /* Do not actually garbage collect, but simply */
101 /* report inaccessible memory that was not */
102 /* deallocated with GC_free. Initial value */
103 /* is determined by FIND_LEAK macro. */
105 GC_API int GC_quiet; /* Disable statistics output. Only matters if */
106 /* collector has been compiled with statistics */
107 /* enabled. This involves a performance cost, */
108 /* and is thus not the default. */
110 GC_API int GC_finalize_on_demand;
111 /* If nonzero, finalizers will only be run in */
112 /* response to an eplit GC_invoke_finalizers */
113 /* call. The default is determined by whether */
114 /* the FINALIZE_ON_DEMAND macro is defined */
115 /* when the collector is built. */
117 GC_API int GC_java_finalization;
118 /* Mark objects reachable from finalizable */
119 /* objects in a separate postpass. This makes */
120 /* it a bit safer to use non-topologically- */
121 /* ordered finalization. Default value is */
122 /* determined by JAVA_FINALIZATION macro. */
124 GC_API int GC_dont_gc; /* Dont collect unless explicitly requested, e.g. */
125 /* because it's not safe. */
127 GC_API int GC_dont_expand;
128 /* Dont expand heap unless explicitly requested */
131 GC_API int GC_full_freq; /* Number of partial collections between */
132 /* full collections. Matters only if */
133 /* GC_incremental is set. */
135 GC_API GC_word GC_non_gc_bytes;
136 /* Bytes not considered candidates for collection. */
137 /* Used only to control scheduling of collections. */
139 GC_API GC_word GC_free_space_divisor;
140 /* We try to make sure that we allocate at */
141 /* least N/GC_free_space_divisor bytes between */
142 /* collections, where N is the heap size plus */
143 /* a rough estimate of the root set size. */
144 /* Initially, GC_free_space_divisor = 4. */
145 /* Increasing its value will use less space */
146 /* but more collection time. Decreasing it */
147 /* will appreciably decrease collection time */
148 /* at the expense of space. */
149 /* GC_free_space_divisor = 1 will effectively */
150 /* disable collections. */
152 GC_API GC_word GC_max_retries;
153 /* The maximum number of GCs attempted before */
154 /* reporting out of memory after heap */
155 /* expansion fails. Initially 0. */
158 GC_API char *GC_stackbottom; /* Cool end of user stack. */
159 /* May be set in the client prior to */
160 /* calling any GC_ routines. This */
161 /* avoids some overhead, and */
162 /* potentially some signals that can */
163 /* confuse debuggers. Otherwise the */
164 /* collector attempts to set it */
166 /* For multithreaded code, this is the */
167 /* cold end of the stack for the */
168 /* primordial thread. */
170 /* Public procedures */
172 * general purpose allocation routines, with roughly malloc calling conv.
173 * The atomic versions promise that no relevant pointers are contained
174 * in the object. The nonatomic versions guarantee that the new object
175 * is cleared. GC_malloc_stubborn promises that no changes to the object
176 * will occur after GC_end_stubborn_change has been called on the
177 * result of GC_malloc_stubborn. GC_malloc_uncollectable allocates an object
178 * that is scanned for pointers to collectable objects, but is not itself
179 * collectable. GC_malloc_uncollectable and GC_free called on the resulting
180 * object implicitly update GC_non_gc_bytes appropriately.
182 GC_API GC_PTR GC_malloc GC_PROTO((size_t size_in_bytes));
183 GC_API GC_PTR GC_malloc_atomic GC_PROTO((size_t size_in_bytes));
184 GC_API GC_PTR GC_malloc_uncollectable GC_PROTO((size_t size_in_bytes));
185 GC_API GC_PTR GC_malloc_stubborn GC_PROTO((size_t size_in_bytes));
187 /* The following is only defined if the library has been suitably */
189 GC_API GC_PTR GC_malloc_atomic_uncollectable GC_PROTO((size_t size_in_bytes));
191 /* Explicitly deallocate an object. Dangerous if used incorrectly. */
192 /* Requires a pointer to the base of an object. */
193 /* If the argument is stubborn, it should not be changeable when freed. */
194 /* An object should not be enable for finalization when it is */
195 /* explicitly deallocated. */
196 /* GC_free(0) is a no-op, as required by ANSI C for free. */
197 GC_API void GC_free GC_PROTO((GC_PTR object_addr));
200 * Stubborn objects may be changed only if the collector is explicitly informed.
201 * The collector is implicitly informed of coming change when such
202 * an object is first allocated. The following routines inform the
203 * collector that an object will no longer be changed, or that it will
204 * once again be changed. Only nonNIL pointer stores into the object
205 * are considered to be changes. The argument to GC_end_stubborn_change
206 * must be exacly the value returned by GC_malloc_stubborn or passed to
207 * GC_change_stubborn. (In the second case it may be an interior pointer
208 * within 512 bytes of the beginning of the objects.)
209 * There is a performance penalty for allowing more than
210 * one stubborn object to be changed at once, but it is acceptable to
211 * do so. The same applies to dropping stubborn objects that are still
214 GC_API void GC_change_stubborn GC_PROTO((GC_PTR));
215 GC_API void GC_end_stubborn_change GC_PROTO((GC_PTR));
217 /* Return a pointer to the base (lowest address) of an object given */
218 /* a pointer to a location within the object. */
219 /* Return 0 if displaced_pointer doesn't point to within a valid */
221 GC_API GC_PTR GC_base GC_PROTO((GC_PTR displaced_pointer));
223 /* Given a pointer to the base of an object, return its size in bytes. */
224 /* The returned size may be slightly larger than what was originally */
226 GC_API size_t GC_size GC_PROTO((GC_PTR object_addr));
228 /* For compatibility with C library. This is occasionally faster than */
229 /* a malloc followed by a bcopy. But if you rely on that, either here */
230 /* or with the standard C library, your code is broken. In my */
231 /* opinion, it shouldn't have been invented, but now we're stuck. -HB */
232 /* The resulting object has the same kind as the original. */
233 /* If the argument is stubborn, the result will have changes enabled. */
234 /* It is an error to have changes enabled for the original object. */
235 /* Follows ANSI comventions for NULL old_object. */
236 GC_API GC_PTR GC_realloc
237 GC_PROTO((GC_PTR old_object, size_t new_size_in_bytes));
239 /* Explicitly increase the heap size. */
240 /* Returns 0 on failure, 1 on success. */
241 GC_API int GC_expand_hp GC_PROTO((size_t number_of_bytes));
243 /* Limit the heap size to n bytes. Useful when you're debugging, */
244 /* especially on systems that don't handle running out of memory well. */
245 /* n == 0 ==> unbounded. This is the default. */
246 GC_API void GC_set_max_heap_size GC_PROTO((GC_word n));
248 /* Inform the collector that a certain section of statically allocated */
249 /* memory contains no pointers to garbage collected memory. Thus it */
250 /* need not be scanned. This is sometimes important if the application */
251 /* maps large read/write files into the address space, which could be */
252 /* mistaken for dynamic library data segments on some systems. */
253 GC_API void GC_exclude_static_roots GC_PROTO((GC_PTR start, GC_PTR finish));
255 /* Clear the set of root segments. Wizards only. */
256 GC_API void GC_clear_roots GC_PROTO((void));
258 /* Add a root segment. Wizards only. */
259 GC_API void GC_add_roots GC_PROTO((char * low_address,
260 char * high_address_plus_1));
262 /* Add a displacement to the set of those considered valid by the */
263 /* collector. GC_register_displacement(n) means that if p was returned */
264 /* by GC_malloc, then (char *)p + n will be considered to be a valid */
265 /* pointer to n. N must be small and less than the size of p. */
266 /* (All pointers to the interior of objects from the stack are */
267 /* considered valid in any case. This applies to heap objects and */
269 /* Preferably, this should be called before any other GC procedures. */
270 /* Calling it later adds to the probability of excess memory */
272 /* This is a no-op if the collector was compiled with recognition of */
273 /* arbitrary interior pointers enabled, which is now the default. */
274 GC_API void GC_register_displacement GC_PROTO((GC_word n));
276 /* The following version should be used if any debugging allocation is */
278 GC_API void GC_debug_register_displacement GC_PROTO((GC_word n));
280 /* Explicitly trigger a full, world-stop collection. */
281 GC_API void GC_gcollect GC_PROTO((void));
283 /* Trigger a full world-stopped collection. Abort the collection if */
284 /* and when stop_func returns a nonzero value. Stop_func will be */
285 /* called frequently, and should be reasonably fast. This works even */
286 /* if virtual dirty bits, and hence incremental collection is not */
287 /* available for this architecture. Collections can be aborted faster */
288 /* than normal pause times for incremental collection. However, */
289 /* aborted collections do no useful work; the next collection needs */
290 /* to start from the beginning. */
291 /* Return 0 if the collection was aborted, 1 if it succeeded. */
292 typedef int (* GC_stop_func) GC_PROTO((void));
293 GC_API int GC_try_to_collect GC_PROTO((GC_stop_func stop_func));
295 /* Return the number of bytes in the heap. Excludes collector private */
296 /* data structures. Includes empty blocks and fragmentation loss. */
297 /* Includes some pages that were allocated but never written. */
298 GC_API size_t GC_get_heap_size GC_PROTO((void));
300 /* Return the number of bytes allocated since the last collection. */
301 GC_API size_t GC_get_bytes_since_gc GC_PROTO((void));
303 /* Enable incremental/generational collection. */
304 /* Not advisable unless dirty bits are */
305 /* available or most heap objects are */
306 /* pointerfree(atomic) or immutable. */
307 /* Don't use in leak finding mode. */
308 /* Ignored if GC_dont_gc is true. */
309 GC_API void GC_enable_incremental GC_PROTO((void));
311 /* Perform some garbage collection work, if appropriate. */
312 /* Return 0 if there is no more work to be done. */
313 /* Typically performs an amount of work corresponding roughly */
314 /* to marking from one page. May do more work if further */
315 /* progress requires it, e.g. if incremental collection is */
316 /* disabled. It is reasonable to call this in a wait loop */
317 /* until it returns 0. */
318 GC_API int GC_collect_a_little GC_PROTO((void));
320 /* Allocate an object of size lb bytes. The client guarantees that */
321 /* as long as the object is live, it will be referenced by a pointer */
322 /* that points to somewhere within the first 256 bytes of the object. */
323 /* (This should normally be declared volatile to prevent the compiler */
324 /* from invalidating this assertion.) This routine is only useful */
325 /* if a large array is being allocated. It reduces the chance of */
326 /* accidentally retaining such an array as a result of scanning an */
327 /* integer that happens to be an address inside the array. (Actually, */
328 /* it reduces the chance of the allocator not finding space for such */
329 /* an array, since it will try hard to avoid introducing such a false */
330 /* reference.) On a SunOS 4.X or MS Windows system this is recommended */
331 /* for arrays likely to be larger than 100K or so. For other systems, */
332 /* or if the collector is not configured to recognize all interior */
333 /* pointers, the threshold is normally much higher. */
334 GC_API GC_PTR GC_malloc_ignore_off_page GC_PROTO((size_t lb));
335 GC_API GC_PTR GC_malloc_atomic_ignore_off_page GC_PROTO((size_t lb));
337 #if defined(__sgi) && !defined(__GNUC__) && _COMPILER_VERSION >= 720
338 # define GC_ADD_CALLER
339 # define GC_RETURN_ADDR (GC_word)__return_address
343 # define GC_EXTRAS GC_RETURN_ADDR, __FILE__, __LINE__
344 # define GC_EXTRA_PARAMS GC_word ra, char * descr_string, int descr_int
346 # define GC_EXTRAS __FILE__, __LINE__
347 # define GC_EXTRA_PARAMS char * descr_string, int descr_int
350 /* Debugging (annotated) allocation. GC_gcollect will check */
351 /* objects allocated in this way for overwrites, etc. */
352 GC_API GC_PTR GC_debug_malloc
353 GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
354 GC_API GC_PTR GC_debug_malloc_atomic
355 GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
356 GC_API GC_PTR GC_debug_malloc_uncollectable
357 GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
358 GC_API GC_PTR GC_debug_malloc_stubborn
359 GC_PROTO((size_t size_in_bytes, GC_EXTRA_PARAMS));
360 GC_API void GC_debug_free GC_PROTO((GC_PTR object_addr));
361 GC_API GC_PTR GC_debug_realloc
362 GC_PROTO((GC_PTR old_object, size_t new_size_in_bytes,
365 GC_API void GC_debug_change_stubborn GC_PROTO((GC_PTR));
366 GC_API void GC_debug_end_stubborn_change GC_PROTO((GC_PTR));
368 # define GC_MALLOC(sz) GC_debug_malloc(sz, GC_EXTRAS)
369 # define GC_MALLOC_ATOMIC(sz) GC_debug_malloc_atomic(sz, GC_EXTRAS)
370 # define GC_MALLOC_UNCOLLECTABLE(sz) GC_debug_malloc_uncollectable(sz, \
372 # define GC_REALLOC(old, sz) GC_debug_realloc(old, sz, GC_EXTRAS)
373 # define GC_FREE(p) GC_debug_free(p)
374 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
375 GC_debug_register_finalizer(p, f, d, of, od)
376 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
377 GC_debug_register_finalizer_ignore_self(p, f, d, of, od)
378 # define GC_MALLOC_STUBBORN(sz) GC_debug_malloc_stubborn(sz, GC_EXTRAS);
379 # define GC_CHANGE_STUBBORN(p) GC_debug_change_stubborn(p)
380 # define GC_END_STUBBORN_CHANGE(p) GC_debug_end_stubborn_change(p)
381 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
382 GC_general_register_disappearing_link(link, GC_base(obj))
383 # define GC_REGISTER_DISPLACEMENT(n) GC_debug_register_displacement(n)
385 # define GC_MALLOC(sz) GC_malloc(sz)
386 # define GC_MALLOC_ATOMIC(sz) GC_malloc_atomic(sz)
387 # define GC_MALLOC_UNCOLLECTABLE(sz) GC_malloc_uncollectable(sz)
388 # define GC_REALLOC(old, sz) GC_realloc(old, sz)
389 # define GC_FREE(p) GC_free(p)
390 # define GC_REGISTER_FINALIZER(p, f, d, of, od) \
391 GC_register_finalizer(p, f, d, of, od)
392 # define GC_REGISTER_FINALIZER_IGNORE_SELF(p, f, d, of, od) \
393 GC_register_finalizer_ignore_self(p, f, d, of, od)
394 # define GC_MALLOC_STUBBORN(sz) GC_malloc_stubborn(sz)
395 # define GC_CHANGE_STUBBORN(p) GC_change_stubborn(p)
396 # define GC_END_STUBBORN_CHANGE(p) GC_end_stubborn_change(p)
397 # define GC_GENERAL_REGISTER_DISAPPEARING_LINK(link, obj) \
398 GC_general_register_disappearing_link(link, obj)
399 # define GC_REGISTER_DISPLACEMENT(n) GC_register_displacement(n)
401 /* The following are included because they are often convenient, and */
402 /* reduce the chance for a misspecifed size argument. But calls may */
403 /* expand to something syntactically incorrect if t is a complicated */
404 /* type expression. */
405 # define GC_NEW(t) (t *)GC_MALLOC(sizeof (t))
406 # define GC_NEW_ATOMIC(t) (t *)GC_MALLOC_ATOMIC(sizeof (t))
407 # define GC_NEW_STUBBORN(t) (t *)GC_MALLOC_STUBBORN(sizeof (t))
408 # define GC_NEW_UNCOLLECTABLE(t) (t *)GC_MALLOC_UNCOLLECTABLE(sizeof (t))
410 /* Finalization. Some of these primitives are grossly unsafe. */
411 /* The idea is to make them both cheap, and sufficient to build */
412 /* a safer layer, closer to PCedar finalization. */
413 /* The interface represents my conclusions from a long discussion */
414 /* with Alan Demers, Dan Greene, Carl Hauser, Barry Hayes, */
415 /* Christian Jacobi, and Russ Atkinson. It's not perfect, and */
416 /* probably nobody else agrees with it. Hans-J. Boehm 3/13/92 */
417 typedef void (*GC_finalization_proc)
418 GC_PROTO((GC_PTR obj, GC_PTR client_data));
420 GC_API void GC_register_finalizer
421 GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
422 GC_finalization_proc *ofn, GC_PTR *ocd));
423 GC_API void GC_debug_register_finalizer
424 GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
425 GC_finalization_proc *ofn, GC_PTR *ocd));
426 /* When obj is no longer accessible, invoke */
427 /* (*fn)(obj, cd). If a and b are inaccessible, and */
428 /* a points to b (after disappearing links have been */
429 /* made to disappear), then only a will be */
430 /* finalized. (If this does not create any new */
431 /* pointers to b, then b will be finalized after the */
432 /* next collection.) Any finalizable object that */
433 /* is reachable from itself by following one or more */
434 /* pointers will not be finalized (or collected). */
435 /* Thus cycles involving finalizable objects should */
436 /* be avoided, or broken by disappearing links. */
437 /* All but the last finalizer registered for an object */
439 /* Finalization may be removed by passing 0 as fn. */
440 /* Finalizers are implicitly unregistered just before */
441 /* they are invoked. */
442 /* The old finalizer and client data are stored in */
444 /* Fn is never invoked on an accessible object, */
445 /* provided hidden pointers are converted to real */
446 /* pointers only if the allocation lock is held, and */
447 /* such conversions are not performed by finalization */
449 /* If GC_register_finalizer is aborted as a result of */
450 /* a signal, the object may be left with no */
451 /* finalization, even if neither the old nor new */
452 /* finalizer were NULL. */
453 /* Obj should be the nonNULL starting address of an */
454 /* object allocated by GC_malloc or friends. */
455 /* Note that any garbage collectable object referenced */
456 /* by cd will be considered accessible until the */
457 /* finalizer is invoked. */
459 /* Another versions of the above follow. It ignores */
460 /* self-cycles, i.e. pointers from a finalizable object to */
461 /* itself. There is a stylistic argument that this is wrong, */
462 /* but it's unavoidable for C++, since the compiler may */
463 /* silently introduce these. It's also benign in that specific */
465 GC_API void GC_register_finalizer_ignore_self
466 GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
467 GC_finalization_proc *ofn, GC_PTR *ocd));
468 GC_API void GC_debug_register_finalizer_ignore_self
469 GC_PROTO((GC_PTR obj, GC_finalization_proc fn, GC_PTR cd,
470 GC_finalization_proc *ofn, GC_PTR *ocd));
472 /* The following routine may be used to break cycles between */
473 /* finalizable objects, thus causing cyclic finalizable */
474 /* objects to be finalized in the correct order. Standard */
475 /* use involves calling GC_register_disappearing_link(&p), */
476 /* where p is a pointer that is not followed by finalization */
477 /* code, and should not be considered in determining */
478 /* finalization order. */
479 GC_API int GC_register_disappearing_link GC_PROTO((GC_PTR * /* link */));
480 /* Link should point to a field of a heap allocated */
481 /* object obj. *link will be cleared when obj is */
482 /* found to be inaccessible. This happens BEFORE any */
483 /* finalization code is invoked, and BEFORE any */
484 /* decisions about finalization order are made. */
485 /* This is useful in telling the finalizer that */
486 /* some pointers are not essential for proper */
487 /* finalization. This may avoid finalization cycles. */
488 /* Note that obj may be resurrected by another */
489 /* finalizer, and thus the clearing of *link may */
490 /* be visible to non-finalization code. */
491 /* There's an argument that an arbitrary action should */
492 /* be allowed here, instead of just clearing a pointer. */
493 /* But this causes problems if that action alters, or */
494 /* examines connectivity. */
495 /* Returns 1 if link was already registered, 0 */
497 /* Only exists for backward compatibility. See below: */
499 GC_API int GC_general_register_disappearing_link
500 GC_PROTO((GC_PTR * /* link */, GC_PTR obj));
501 /* A slight generalization of the above. *link is */
502 /* cleared when obj first becomes inaccessible. This */
503 /* can be used to implement weak pointers easily and */
504 /* safely. Typically link will point to a location */
505 /* holding a disguised pointer to obj. (A pointer */
506 /* inside an "atomic" object is effectively */
507 /* disguised.) In this way soft */
508 /* pointers are broken before any object */
509 /* reachable from them are finalized. Each link */
510 /* May be registered only once, i.e. with one obj */
511 /* value. This was added after a long email discussion */
512 /* with John Ellis. */
513 /* Obj must be a pointer to the first word of an object */
514 /* we allocated. It is unsafe to explicitly deallocate */
515 /* the object containing link. Explicitly deallocating */
516 /* obj may or may not cause link to eventually be */
518 GC_API int GC_unregister_disappearing_link GC_PROTO((GC_PTR * /* link */));
519 /* Returns 0 if link was not actually registered. */
520 /* Undoes a registration by either of the above two */
523 /* Auxiliary fns to make finalization work correctly with displaced */
524 /* pointers introduced by the debugging allocators. */
525 GC_API GC_PTR GC_make_closure GC_PROTO((GC_finalization_proc fn, GC_PTR data));
526 GC_API void GC_debug_invoke_finalizer GC_PROTO((GC_PTR obj, GC_PTR data));
528 GC_API int GC_invoke_finalizers GC_PROTO((void));
529 /* Run finalizers for all objects that are ready to */
530 /* be finalized. Return the number of finalizers */
531 /* that were run. Normally this is also called */
532 /* implicitly during some allocations. If */
533 /* GC-finalize_on_demand is nonzero, it must be called */
536 /* GC_set_warn_proc can be used to redirect or filter warning messages. */
537 /* p may not be a NULL pointer. */
538 typedef void (*GC_warn_proc) GC_PROTO((char *msg, GC_word arg));
539 GC_API GC_warn_proc GC_set_warn_proc GC_PROTO((GC_warn_proc p));
540 /* Returns old warning procedure. */
542 /* The following is intended to be used by a higher level */
543 /* (e.g. cedar-like) finalization facility. It is expected */
544 /* that finalization code will arrange for hidden pointers to */
545 /* disappear. Otherwise objects can be accessed after they */
546 /* have been collected. */
547 /* Note that putting pointers in atomic objects or in */
548 /* nonpointer slots of "typed" objects is equivalent to */
549 /* disguising them in this way, and may have other advantages. */
550 # if defined(I_HIDE_POINTERS) || defined(GC_I_HIDE_POINTERS)
551 typedef GC_word GC_hidden_pointer;
552 # define HIDE_POINTER(p) (~(GC_hidden_pointer)(p))
553 # define REVEAL_POINTER(p) ((GC_PTR)(HIDE_POINTER(p)))
554 /* Converting a hidden pointer to a real pointer requires verifying */
555 /* that the object still exists. This involves acquiring the */
556 /* allocator lock to avoid a race with the collector. */
557 # endif /* I_HIDE_POINTERS */
559 typedef GC_PTR (*GC_fn_type) GC_PROTO((GC_PTR client_data));
560 GC_API GC_PTR GC_call_with_alloc_lock
561 GC_PROTO((GC_fn_type fn, GC_PTR client_data));
563 /* Check that p and q point to the same object. */
564 /* Fail conspicuously if they don't. */
565 /* Returns the first argument. */
566 /* Succeeds if neither p nor q points to the heap. */
567 /* May succeed if both p and q point to between heap objects. */
568 GC_API GC_PTR GC_same_obj GC_PROTO((GC_PTR p, GC_PTR q));
570 /* Checked pointer pre- and post- increment operations. Note that */
571 /* the second argument is in units of bytes, not multiples of the */
572 /* object size. This should either be invoked from a macro, or the */
573 /* call should be automatically generated. */
574 GC_API GC_PTR GC_pre_incr GC_PROTO((GC_PTR *p, size_t how_much));
575 GC_API GC_PTR GC_post_incr GC_PROTO((GC_PTR *p, size_t how_much));
577 /* Check that p is visible */
578 /* to the collector as a possibly pointer containing location. */
579 /* If it isn't fail conspicuously. */
580 /* Returns the argument in all cases. May erroneously succeed */
581 /* in hard cases. (This is intended for debugging use with */
582 /* untyped allocations. The idea is that it should be possible, though */
583 /* slow, to add such a call to all indirect pointer stores.) */
584 /* Currently useless for multithreaded worlds. */
585 GC_API GC_PTR GC_is_visible GC_PROTO((GC_PTR p));
587 /* Check that if p is a pointer to a heap page, then it points to */
588 /* a valid displacement within a heap object. */
589 /* Fail conspicuously if this property does not hold. */
590 /* Uninteresting with ALL_INTERIOR_POINTERS. */
591 /* Always returns its argument. */
592 GC_API GC_PTR GC_is_valid_displacement GC_PROTO((GC_PTR p));
594 /* Safer, but slow, pointer addition. Probably useful mainly with */
595 /* a preprocessor. Useful only for heap pointers. */
597 # define GC_PTR_ADD3(x, n, type_of_result) \
598 ((type_of_result)GC_same_obj((x)+(n), (x)))
599 # define GC_PRE_INCR3(x, n, type_of_result) \
600 ((type_of_result)GC_pre_incr(&(x), (n)*sizeof(*x))
601 # define GC_POST_INCR2(x, type_of_result) \
602 ((type_of_result)GC_post_incr(&(x), sizeof(*x))
604 # define GC_PTR_ADD(x, n) \
605 GC_PTR_ADD3(x, n, typeof(x))
606 # define GC_PRE_INCR(x, n) \
607 GC_PRE_INCR3(x, n, typeof(x))
608 # define GC_POST_INCR(x, n) \
609 GC_POST_INCR3(x, typeof(x))
611 /* We can't do this right without typeof, which ANSI */
612 /* decided was not sufficiently useful. Repeatedly */
613 /* mentioning the arguments seems too dangerous to be */
614 /* useful. So does not casting the result. */
615 # define GC_PTR_ADD(x, n) ((x)+(n))
617 #else /* !GC_DEBUG */
618 # define GC_PTR_ADD3(x, n, type_of_result) ((x)+(n))
619 # define GC_PTR_ADD(x, n) ((x)+(n))
620 # define GC_PRE_INCR3(x, n, type_of_result) ((x) += (n))
621 # define GC_PRE_INCR(x, n) ((x) += (n))
622 # define GC_POST_INCR2(x, n, type_of_result) ((x)++)
623 # define GC_POST_INCR(x, n) ((x)++)
626 /* Safer assignment of a pointer to a nonstack location. */
629 # define GC_PTR_STORE(p, q) \
630 (*(void **)GC_is_visible(p) = GC_is_valid_displacement(q))
632 # define GC_PTR_STORE(p, q) \
633 (*(char **)GC_is_visible(p) = GC_is_valid_displacement(q))
635 #else /* !GC_DEBUG */
636 # define GC_PTR_STORE(p, q) *((p) = (q))
639 /* Fynctions called to report pointer checking errors */
640 GC_API void (*GC_same_obj_print_proc) GC_PROTO((GC_PTR p, GC_PTR q));
642 GC_API void (*GC_is_valid_displacement_print_proc)
643 GC_PROTO((GC_PTR p));
645 GC_API void (*GC_is_visible_print_proc)
646 GC_PROTO((GC_PTR p));
648 #if defined(_SOLARIS_PTHREADS) && !defined(SOLARIS_THREADS)
649 # define SOLARIS_THREADS
652 #ifdef SOLARIS_THREADS
653 /* We need to intercept calls to many of the threads primitives, so */
654 /* that we can locate thread stacks and stop the world. */
655 /* Note also that the collector cannot see thread specific data. */
656 /* Thread specific data should generally consist of pointers to */
657 /* uncollectable objects, which are deallocated using the destructor */
658 /* facility in thr_keycreate. */
661 int GC_thr_create(void *stack_base, size_t stack_size,
662 void *(*start_routine)(void *), void *arg, long flags,
663 thread_t *new_thread);
664 int GC_thr_join(thread_t wait_for, thread_t *departed, void **status);
665 int GC_thr_suspend(thread_t target_thread);
666 int GC_thr_continue(thread_t target_thread);
667 void * GC_dlopen(const char *path, int mode);
669 # ifdef _SOLARIS_PTHREADS
670 # include <pthread.h>
671 extern int GC_pthread_create(pthread_t *new_thread,
672 const pthread_attr_t *attr,
673 void * (*thread_execp)(void *), void *arg);
674 extern int GC_pthread_join(pthread_t wait_for, void **status);
678 # define pthread_join GC_pthread_join
679 # define pthread_create GC_pthread_create
682 # define thr_create GC_thr_create
683 # define thr_join GC_thr_join
684 # define thr_suspend GC_thr_suspend
685 # define thr_continue GC_thr_continue
686 # define dlopen GC_dlopen
688 # endif /* SOLARIS_THREADS */
691 #if defined(IRIX_THREADS) || defined(LINUX_THREADS)
692 /* We treat these similarly. */
693 # include <pthread.h>
696 int GC_pthread_create(pthread_t *new_thread,
697 const pthread_attr_t *attr,
698 void *(*start_routine)(void *), void *arg);
699 int GC_pthread_sigmask(int how, const sigset_t *set, sigset_t *oset);
700 int GC_pthread_join(pthread_t thread, void **retval);
702 # define pthread_create GC_pthread_create
703 # define pthread_sigmask GC_pthread_sigmask
704 # define pthread_join GC_pthread_join
706 #endif /* IRIX_THREADS || LINUX_THREADS */
708 # if defined(PCR) || defined(SOLARIS_THREADS) || defined(WIN32_THREADS) || \
709 defined(IRIX_THREADS) || defined(LINUX_THREADS) || \
710 defined(IRIX_JDK_THREADS)
711 /* Any flavor of threads except SRC_M3. */
712 /* This returns a list of objects, linked through their first */
713 /* word. Its use can greatly reduce lock contention problems, since */
714 /* the allocation lock can be acquired and released many fewer times. */
715 /* lb must be large enough to hold the pointer field. */
716 GC_PTR GC_malloc_many(size_t lb);
717 #define GC_NEXT(p) (*(GC_PTR *)(p)) /* Retrieve the next element */
718 /* in returned list. */
719 extern void GC_thr_init(); /* Needed for Solaris/X86 */
721 #endif /* THREADS && !SRC_M3 */
724 * If you are planning on putting
725 * the collector in a SunOS 5 dynamic library, you need to call GC_INIT()
726 * from the statically loaded program section.
727 * This circumvents a Solaris 2.X (X<=4) linker bug.
729 #if defined(sparc) || defined(__sparc)
730 # define GC_INIT() { extern end, etext; \
731 GC_noop(&end, &etext); }
733 # if defined(__CYGWIN32__) && defined(GC_USE_DLL)
735 * Similarly gnu-win32 DLLs need explicit initialization
737 # define GC_INIT() { GC_add_roots(DATASTART, DATAEND); }
743 #if (defined(_MSDOS) || defined(_MSC_VER)) && (_M_IX86 >= 300) \
745 /* win32S may not free all resources on process exit. */
746 /* This explicitly deallocates the heap. */
747 GC_API void GC_win32_free_heap ();
751 } /* end of extern "C" */
projects / fw / sdcc / blob