Mention potential memory fragmentation due to too-high arena count

This commit is contained in:
inference 2024-01-29 18:55:00 +00:00
parent 32e873ae32
commit e3ba86d7ca
Signed by: inference
SSH Key Fingerprint: SHA256:FtEVfx1CmTKMy40VwZvF4k+3TC+QhCWy+EmPRg50Nnc

View File

@ -1,7 +1,7 @@
<!DOCTYPE html> <!DOCTYPE html>
<!-- Inferencium - Website - Documentation - hardened_malloc --> <!-- Inferencium - Website - Documentation - hardened_malloc -->
<!-- Version: 3.0.0-alpha.5 --> <!-- Version: 3.0.0-alpha.6 -->
<!-- Copyright 2023 Jake Winters --> <!-- Copyright 2023 Jake Winters -->
<!-- SPDX-License-Identifier: BSD-3-Clause --> <!-- SPDX-License-Identifier: BSD-3-Clause -->
@ -73,10 +73,11 @@
<p><code>CONFIG_N_ARENA=<var>n</var></code> can be adjusted to increase parallel <p><code>CONFIG_N_ARENA=<var>n</var></code> can be adjusted to increase parallel
performance at the expense of memory usage, or decrease memory usage at the expense of performance at the expense of memory usage, or decrease memory usage at the expense of
parallel performance, where <var>n</var> is an integer. Higher values prefer parallel parallel performance, where <var>n</var> is an integer. Higher values prefer parallel
performance, lower values prefer lower memory usage. The number of arenas has no impact performance, whereas lower values prefer lower memory usage. Note that having too many
on the security properties of hardened_malloc.<br/> arenas may cause memory fragmentation and decrease system performance. The number of
<b>Minimum number of arenas:</b> 1<br/> arenas has no impact on the security properties of hardened_malloc.</p>
<b>Maximum number of arenas:</b> 256</p> <p><b>Minimum number of arenas:</b> 1</p>
<p><b>Maximum number of arenas:</b> 256</p>
<p>For extra security, <code>CONFIG_SEAL_METADATA=true</code> can be used in order to <p>For extra security, <code>CONFIG_SEAL_METADATA=true</code> can be used in order to
control whether Memory Protection Keys are used to disable access to all writable control whether Memory Protection Keys are used to disable access to all writable
allocator state outside of the memory allocator code. It's currently disabled by default allocator state outside of the memory allocator code. It's currently disabled by default