Skip to content

Commit 1a66f10

Browse files
committed
Document mitigations/ layer in include hierarchy README
1 parent 2dba9af commit 1a66f10

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

src/snmalloc/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ These are arranged in a hierarchy such that each of the directories may include
1010
This layer provides abstractions over CPU-specific intrinsics and defines things such as the virtual address-space size.
1111
There is a single AAL for an snmalloc instantiation.
1212
- `ds_aal/` provides data structures that depend on the AAL.
13+
- `mitigations/` provides compile-time configuration for security mitigations.
14+
This includes the `mitigations()` function (controlled by `SNMALLOC_CHECK_CLIENT`), mitigation-dependent allocator constants, and CHERI capability checks.
15+
Layers below this (`ds_core/`, `aal/`, `ds_aal/`) are mitigation-independent, which allows code that only includes those layers to be compiled once regardless of mitigation settings.
1316
- `pal/` provides the platform abstraction layer (PAL).
1417
This exposes OS- or environment-specific abstractions into the rest of the code.
1518
An snmalloc instantiation may use more than one PAL, including ones provided by the user.

0 commit comments

Comments
 (0)