summaryrefslogtreecommitdiff
path: root/include/gc_disclaim.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gc_disclaim.h')
-rw-r--r--include/gc_disclaim.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/gc_disclaim.h b/include/gc_disclaim.h
index 8123838e..f2942cdb 100644
--- a/include/gc_disclaim.h
+++ b/include/gc_disclaim.h
@@ -39,6 +39,8 @@ typedef int (GC_CALLBACK * GC_disclaim_proc)(void * /*obj*/);
/* (including the referred closure object) will be protected from */
/* collection if "mark_from_all" is non-zero, but at the expense that */
/* long chains of objects will take many cycles to reclaim. */
+/* Calls to GC_free() will free its argument without inquiring "proc". */
+/* No-op in the leak-finding mode. */
GC_API void GC_CALL GC_register_disclaim_proc(int /*kind*/,
GC_disclaim_proc /*proc*/,
int /*mark_from_all*/) GC_ATTR_NONNULL(2);
@@ -60,6 +62,7 @@ struct GC_finalizer_closure {
/* Note that GC_size (applied to such allocated object) returns a value */
/* slightly bigger than the specified allocation size, and that GC_base */
/* result points to a word prior to the start of the allocated object. */
+/* The disclaim procedure is not invoked in the leak-finding mode. */
GC_API GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1) void * GC_CALL
GC_finalized_malloc(size_t /*size*/,
const struct GC_finalizer_closure * /*fc*/) GC_ATTR_NONNULL(2);