diff options
| author | Jason Evans <je@fb.com> | 2016-02-25 15:29:49 -0800 |
|---|---|---|
| committer | Jason Evans <je@fb.com> | 2016-02-25 15:29:49 -0800 |
| commit | 0c516a00c4cb28cff55ce0995f756b5aae074c9e (patch) | |
| tree | 9752d36c7303bae8567cc01ec0347d658c6d7207 /doc | |
| parent | 767d85061a6fb88ec977bbcd9b429a43aff391e6 (diff) | |
| download | jemalloc-0c516a00c4cb28cff55ce0995f756b5aae074c9e.tar.gz | |
Make *allocx() size class overflow behavior defined.
Limit supported size and alignment to HUGE_MAXCLASS, which in turn is
now limited to be less than PTRDIFF_MAX.
This resolves #278 and #295.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/jemalloc.xml.in | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/doc/jemalloc.xml.in b/doc/jemalloc.xml.in index d7b3358..bc5dbd1 100644 --- a/doc/jemalloc.xml.in +++ b/doc/jemalloc.xml.in @@ -310,16 +310,14 @@ <para>The <function>mallocx<parameter/></function> function allocates at least <parameter>size</parameter> bytes of memory, and returns a pointer to the base address of the allocation. Behavior is undefined if - <parameter>size</parameter> is <constant>0</constant>, or if request size - overflows due to size class and/or alignment constraints.</para> + <parameter>size</parameter> is <constant>0</constant>.</para> <para>The <function>rallocx<parameter/></function> function resizes the allocation at <parameter>ptr</parameter> to be at least <parameter>size</parameter> bytes, and returns a pointer to the base address of the resulting allocation, which may or may not have moved from its original location. Behavior is undefined if - <parameter>size</parameter> is <constant>0</constant>, or if request size - overflows due to size class and/or alignment constraints.</para> + <parameter>size</parameter> is <constant>0</constant>.</para> <para>The <function>xallocx<parameter/></function> function resizes the allocation at <parameter>ptr</parameter> in place to be at least @@ -354,10 +352,10 @@ memory, but it performs the same size computation as the <function>mallocx<parameter/></function> function, and returns the real size of the allocation that would result from the equivalent - <function>mallocx<parameter/></function> function call. Behavior is - undefined if <parameter>size</parameter> is <constant>0</constant>, or if - request size overflows due to size class and/or alignment - constraints.</para> + <function>mallocx<parameter/></function> function call, or + <constant>0</constant> if the inputs exceed the maximum supported size + class and/or alignment. Behavior is undefined if + <parameter>size</parameter> is <constant>0</constant>.</para> <para>The <function>mallctl<parameter/></function> function provides a general interface for introspecting the memory allocator, as well as |