readme.md
1Testing allocators is difficult as bugs may only surface after particular
2allocation patterns. The main approach to testing _mimalloc_ is therefore
3to have extensive internal invariant checking (see `page_is_valid` in `page.c`
4for example), which is enabled in debug mode with `-DMI_DEBUG_FULL=ON`.
5The main testing strategy is then to run [`mimalloc-bench`][bench] using full
6invariant checking to catch any potential problems over a wide range of intensive
7allocation benchmarks and programs.
8
9However, this does not test well for the entire API surface and this is tested
10with `test-api.c` when using `make test` (from `out/debug` etc). (This is
11not complete yet, please add to it.)
12
13The `main.c` and `main-override.c` are there to test if building and overriding
14from a local install works and therefore these build a separate `test/CMakeLists.txt`.
15
16[bench]: https://github.com/daanx/mimalloc-bench
17