Update GrapheneOS hardened_malloc documentation from version 0.0.0.3 to 0.0.0.7.

This commit is contained in:
inference 2023-06-12 17:39:13 +01:00
parent ef83079e6b
commit 9d703608e9
Signed by: inference
SSH Key Fingerprint: SHA256:9Pl0nZ2UJacgm+IeEtLSZ4FOESgP1eKCtRflfPfdX9M

View File

@ -1,9 +1,9 @@
= GrapheneOS hardened_malloc
Version: 0.0.0.3
Version: 0.0.0.7
This documentation contains the instructions to use
This documentation contains instructions to use
https://github.com/GrapheneOS/hardened_malloc[GrapheneOS' hardened_malloc] memory allocator as the
system's default memory allocator. These instructions apply to both musl and glibc C libraries on
Unix-based and Unix-like systems.
@ -27,9 +27,10 @@ of guard pages.
`make <arguments>`
`CONFIG_N_ARENA=n` can be adjusted to increase parallel performance at the expense of memory usage,
or decrease memory usage at the expense of parallel performance, where `n` is an integer. For
low-memory systems, `VARIANT=light` can be used to compile the light variant of hardened_malloc,
which sacrifices some security for much less memory usage.
or decrease memory usage at the expense of parallel performance, where `n` is an integer; higher
values prefer parallel performance, lower values prefer lower memory usage. For low-memory systems,
`VARIANT=light` can be used to compile the light variant of hardened_malloc, which sacrifices some
security for much less memory usage.
== Copy Compiled hardened_malloc Library
@ -37,5 +38,6 @@ which sacrifices some security for much less memory usage.
== Set System to Preload hardened_malloc on Boot
musl-based systems: Add `export LD_PRELOAD=<hardened_malloc_path>` to `/etc/environment` +
musl-based systems: Add `export LD_PRELOAD="<hardened_malloc_path>"` to `/etc/environment` +
+
glibc-based systems: Add `<hardened_malloc_path>` to `/etc/ld.so.preload`