aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQi Wang <interwq@gwu.edu>2018-04-11 12:09:48 -0700
committerQi Wang <interwq@gmail.com>2018-04-11 12:35:28 -0700
commit02585420c34e08db1de4c26f3d5bc808d6910131 (patch)
treefcc1818b584b9887c1cb171e9dfc6ea76905e17f
parentf0b146acc4d48d1d829a8099aee7bc91267d8209 (diff)
downloadplatform_external_jemalloc_new-02585420c34e08db1de4c26f3d5bc808d6910131.tar.gz
platform_external_jemalloc_new-02585420c34e08db1de4c26f3d5bc808d6910131.tar.bz2
platform_external_jemalloc_new-02585420c34e08db1de4c26f3d5bc808d6910131.zip
Document liveness requirements for extent_hooks_t structures.
-rw-r--r--doc/jemalloc.xml.in4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/jemalloc.xml.in b/doc/jemalloc.xml.in
index 2e7edc33..3ec43ce1 100644
--- a/doc/jemalloc.xml.in
+++ b/doc/jemalloc.xml.in
@@ -1792,7 +1792,9 @@ struct extent_hooks_s {
in favor of less permanent (and often less costly) operations. All
operations except allocation can be universally opted out of by setting
the hook pointers to <constant>NULL</constant>, or selectively opted out
- of by returning failure.</para>
+ of by returning failure. Note that once the extent hook is set, the
+ structure is accessed directly by the associated arenas, so it must
+ remain valid for the entire lifetime of the arenas.</para>
<funcsynopsis><funcprototype>
<funcdef>typedef void *<function>(extent_alloc_t)</function></funcdef>