diff options
Diffstat (limited to 'include/gc')
| -rw-r--r-- | include/gc/gc.h | 14 | ||||
| -rw-r--r-- | include/gc/gc_gcj.h | 3 | ||||
| -rw-r--r-- | include/gc/gc_mark.h | 2 |
3 files changed, 10 insertions, 9 deletions
diff --git a/include/gc/gc.h b/include/gc/gc.h index 6bf37930..d4c8f2da 100644 --- a/include/gc/gc.h +++ b/include/gc/gc.h @@ -955,13 +955,13 @@ GC_API void GC_CALL GC_start_incremental_collection(void); /* until it returns 0. */ GC_API int GC_CALL GC_collect_a_little(void); -/* Allocate an object of size lb bytes. The client guarantees that */ -/* as long as the object is live, it will be referenced by a pointer */ -/* that points to somewhere within the first 256 bytes of the object. */ -/* (This should normally be declared volatile to prevent the compiler */ -/* from invalidating this assertion.) This routine is only useful */ -/* if a large array is being allocated. It reduces the chance of */ -/* accidentally retaining such an array as a result of scanning an */ +/* Allocate an object of size lb bytes. The client guarantees that as */ +/* long as the object is live, it will be referenced by a pointer that */ +/* points to somewhere within the first GC heap block (hblk) of the */ +/* object. (This should normally be declared volatile to prevent the */ +/* compiler from invalidating this assertion.) This routine is only */ +/* useful if a large array is being allocated. It reduces the chance */ +/* of accidentally retaining such an array as a result of scanning an */ /* integer that happens to be an address inside the array. (Actually, */ /* it reduces the chance of the allocator not finding space for such */ /* an array, since it will try hard to avoid introducing such a false */ diff --git a/include/gc/gc_gcj.h b/include/gc/gc_gcj.h index 0520fba1..63e4d803 100644 --- a/include/gc/gc_gcj.h +++ b/include/gc/gc_gcj.h @@ -84,7 +84,8 @@ GC_API GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1) void * GC_CALL GC_EXTRA_PARAMS); /* Similar to GC_gcj_malloc, but assumes that a pointer to near the */ -/* beginning of the resulting object is always maintained. */ +/* beginning (i.e. within the first heap block) of the allocated object */ +/* is always maintained. */ GC_API GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1) void * GC_CALL GC_gcj_malloc_ignore_off_page(size_t /* lb */, void * /* ptr_to_struct_containing_descr */); diff --git a/include/gc/gc_mark.h b/include/gc/gc_mark.h index adbc28ab..8291b1a4 100644 --- a/include/gc/gc_mark.h +++ b/include/gc/gc_mark.h @@ -256,7 +256,7 @@ GC_API GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1) void * GC_CALL GC_generic_malloc_ignore_off_page( size_t /* lb */, int /* knd */); /* As above, but pointers to past the */ - /* first page of the resulting object */ + /* first hblk of the resulting object */ /* are ignored. */ /* Generalized version of GC_malloc_[atomic_]uncollectable. */ |